_ 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::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, MppId, RAACommitmentOrder, PaymentSendFailure, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA};
  23 use ln::channel::{Channel, ChannelError};
  24 use ln::{chan_utils, onion_utils};
  25 use ln::chan_utils::HTLC_SUCCESS_TX_WEIGHT;
  26 use routing::router::{Route, RouteHop, RouteHint, RouteHintHop, get_route, get_keysend_route};
  27 use routing::network_graph::{NetworkUpdate, RoutingFees};
  28 use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
  29 use ln::msgs;
  30 use ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
  31 use util::enforcing_trait_impls::EnforcingSigner;
  32 use util::{byte_utils, test_utils};
  33 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
  34 use util::errors::APIError;
  35 use util::ser::{Writeable, ReadableArgs};
  36 use util::config::UserConfig;
  37
  38 use bitcoin::hash_types::{Txid, BlockHash};
  39 use bitcoin::blockdata::block::{Block, BlockHeader};
  40 use bitcoin::blockdata::script::Builder;
  41 use bitcoin::blockdata::opcodes;
  42 use bitcoin::blockdata::constants::genesis_block;
  43 use bitcoin::network::constants::Network;
  44
  45 use bitcoin::hashes::sha256::Hash as Sha256;
  46 use bitcoin::hashes::Hash;
  47
  48 use bitcoin::secp256k1::Secp256k1;
  49 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
  50
  51 use regex;
  52
  53 use io;
  54 use prelude::*;
  55 use alloc::collections::BTreeSet;
  56 use core::default::Default;
  57 use sync::{Arc, Mutex};
  58
  59 use ln::functional_test_utils::*;
  60 use ln::chan_utils::CommitmentTransaction;
  61
  62 #[test]
  63 fn test_insane_channel_opens() {
  64         // Stand up a network of 2 nodes
  65         let chanmon_cfgs = create_chanmon_cfgs(2);
  66         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  67         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  68         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  69
  70         // Instantiate channel parameters where we push the maximum msats given our
  71         // funding satoshis
  72         let channel_value_sat = 31337; // same as funding satoshis
  73         let channel_reserve_satoshis = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value_sat);
  74         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  75
  76         // Have node0 initiate a channel to node1 with aforementioned parameters
  77         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
  78
  79         // Extract the channel open message from node0 to node1
  80         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  81
  82         // Test helper that asserts we get the correct error string given a mutator
  83         // that supposedly makes the channel open message insane
  84         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  85                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
  86                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  87                 assert_eq!(msg_events.len(), 1);
  88                 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
  89                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  90                         match action {
  91                                 &ErrorAction::SendErrorMessage { .. } => {
  92                                         nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
  93                                 },
  94                                 _ => panic!("unexpected event!"),
  95                         }
  96                 } else { assert!(false); }
  97         };
  98
  99         use ln::channel::MAX_FUNDING_SATOSHIS;
 100         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
 101
 102         // Test all mutations that would make the channel open message insane
 103         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 });
 104
 105         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
 106
 107         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 });
 108
 109         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
 110
 111         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 });
 112
 113         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 });
 114
 115         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 });
 116
 117         insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 118
 119         insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 120 }
 121
 122 #[test]
 123 fn test_async_inbound_update_fee() {
 124         let chanmon_cfgs = create_chanmon_cfgs(2);
 125         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 126         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 127         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 128         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 129         let logger = test_utils::TestLogger::new();
 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         {
 153                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 154                 *feerate_lock += 20;
 155         }
 156         nodes[0].node.timer_tick_occurred();
 157         check_added_monitors!(nodes[0], 1);
 158
 159         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 160         assert_eq!(events_0.len(), 1);
 161         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 162                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 163                         (update_fee.as_ref(), commitment_signed)
 164                 },
 165                 _ => panic!("Unexpected event"),
 166         };
 167
 168         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 169
 170         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 171         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 172         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 173         nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &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();
 174         check_added_monitors!(nodes[1], 1);
 175
 176         let payment_event = {
 177                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 178                 assert_eq!(events_1.len(), 1);
 179                 SendEvent::from_event(events_1.remove(0))
 180         };
 181         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 182         assert_eq!(payment_event.msgs.len(), 1);
 183
 184         // ...now when the messages get delivered everyone should be happy
 185         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 186         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 187         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 188         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 189         check_added_monitors!(nodes[0], 1);
 190
 191         // deliver(1), generate (3):
 192         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 193         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 194         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 195         check_added_monitors!(nodes[1], 1);
 196
 197         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 198         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 199         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 200         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 201         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 202         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 203         assert!(bs_update.update_fee.is_none()); // (4)
 204         check_added_monitors!(nodes[1], 1);
 205
 206         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 207         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 208         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 209         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 210         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 211         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 212         assert!(as_update.update_fee.is_none()); // (5)
 213         check_added_monitors!(nodes[0], 1);
 214
 215         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 216         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 217         // only (6) so get_event_msg's assert(len == 1) passes
 218         check_added_monitors!(nodes[0], 1);
 219
 220         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 221         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 222         check_added_monitors!(nodes[1], 1);
 223
 224         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 225         check_added_monitors!(nodes[0], 1);
 226
 227         let events_2 = nodes[0].node.get_and_clear_pending_events();
 228         assert_eq!(events_2.len(), 1);
 229         match events_2[0] {
 230                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 231                 _ => panic!("Unexpected event"),
 232         }
 233
 234         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 235         check_added_monitors!(nodes[1], 1);
 236 }
 237
 238 #[test]
 239 fn test_update_fee_unordered_raa() {
 240         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 241         // crash in an earlier version of the update_fee patch)
 242         let chanmon_cfgs = create_chanmon_cfgs(2);
 243         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 244         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 245         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 246         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 247         let logger = test_utils::TestLogger::new();
 248
 249         // balancing
 250         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 251
 252         // First nodes[0] generates an update_fee
 253         {
 254                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 255                 *feerate_lock += 20;
 256         }
 257         nodes[0].node.timer_tick_occurred();
 258         check_added_monitors!(nodes[0], 1);
 259
 260         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 261         assert_eq!(events_0.len(), 1);
 262         let update_msg = match events_0[0] { // (1)
 263                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 264                         update_fee.as_ref()
 265                 },
 266                 _ => panic!("Unexpected event"),
 267         };
 268
 269         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 270
 271         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 272         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 273         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 274         nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &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();
 275         check_added_monitors!(nodes[1], 1);
 276
 277         let payment_event = {
 278                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 279                 assert_eq!(events_1.len(), 1);
 280                 SendEvent::from_event(events_1.remove(0))
 281         };
 282         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 283         assert_eq!(payment_event.msgs.len(), 1);
 284
 285         // ...now when the messages get delivered everyone should be happy
 286         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 287         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 288         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 289         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 290         check_added_monitors!(nodes[0], 1);
 291
 292         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 293         check_added_monitors!(nodes[1], 1);
 294
 295         // We can't continue, sadly, because our (1) now has a bogus signature
 296 }
 297
 298 #[test]
 299 fn test_multi_flight_update_fee() {
 300         let chanmon_cfgs = create_chanmon_cfgs(2);
 301         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 302         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 303         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 304         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 305
 306         // A                                        B
 307         // update_fee/commitment_signed          ->
 308         //                                       .- send (1) RAA and (2) commitment_signed
 309         // update_fee (never committed)          ->
 310         // (3) update_fee                        ->
 311         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 312         // don't track which updates correspond to which revoke_and_ack responses so we're in
 313         // AwaitingRAA mode and will not generate the update_fee yet.
 314         //                                       <- (1) RAA delivered
 315         // (3) is generated and send (4) CS      -.
 316         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 317         // know the per_commitment_point to use for it.
 318         //                                       <- (2) commitment_signed delivered
 319         // revoke_and_ack                        ->
 320         //                                          B should send no response here
 321         // (4) commitment_signed delivered       ->
 322         //                                       <- RAA/commitment_signed delivered
 323         // revoke_and_ack                        ->
 324
 325         // First nodes[0] generates an update_fee
 326         let initial_feerate;
 327         {
 328                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 329                 initial_feerate = *feerate_lock;
 330                 *feerate_lock = initial_feerate + 20;
 331         }
 332         nodes[0].node.timer_tick_occurred();
 333         check_added_monitors!(nodes[0], 1);
 334
 335         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 336         assert_eq!(events_0.len(), 1);
 337         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 338                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 339                         (update_fee.as_ref().unwrap(), commitment_signed)
 340                 },
 341                 _ => panic!("Unexpected event"),
 342         };
 343
 344         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 345         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 346         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 347         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 348         check_added_monitors!(nodes[1], 1);
 349
 350         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 351         // transaction:
 352         {
 353                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 354                 *feerate_lock = initial_feerate + 40;
 355         }
 356         nodes[0].node.timer_tick_occurred();
 357         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 358         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 359
 360         // Create the (3) update_fee message that nodes[0] will generate before it does...
 361         let mut update_msg_2 = msgs::UpdateFee {
 362                 channel_id: update_msg_1.channel_id.clone(),
 363                 feerate_per_kw: (initial_feerate + 30) as u32,
 364         };
 365
 366         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 367
 368         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 369         // Deliver (3)
 370         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 371
 372         // Deliver (1), generating (3) and (4)
 373         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 374         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 375         check_added_monitors!(nodes[0], 1);
 376         assert!(as_second_update.update_add_htlcs.is_empty());
 377         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 378         assert!(as_second_update.update_fail_htlcs.is_empty());
 379         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 380         // Check that the update_fee newly generated matches what we delivered:
 381         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 382         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 383
 384         // Deliver (2) commitment_signed
 385         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 386         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 387         check_added_monitors!(nodes[0], 1);
 388         // No commitment_signed so get_event_msg's assert(len == 1) passes
 389
 390         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 391         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 392         check_added_monitors!(nodes[1], 1);
 393
 394         // Delever (4)
 395         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 396         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 397         check_added_monitors!(nodes[1], 1);
 398
 399         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 400         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 401         check_added_monitors!(nodes[0], 1);
 402
 403         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 404         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 405         // No commitment_signed so get_event_msg's assert(len == 1) passes
 406         check_added_monitors!(nodes[0], 1);
 407
 408         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 409         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 410         check_added_monitors!(nodes[1], 1);
 411 }
 412
 413 fn do_test_1_conf_open(connect_style: ConnectStyle) {
 414         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 415         // tests that we properly send one in that case.
 416         let mut alice_config = UserConfig::default();
 417         alice_config.own_channel_config.minimum_depth = 1;
 418         alice_config.channel_options.announced_channel = true;
 419         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 420         let mut bob_config = UserConfig::default();
 421         bob_config.own_channel_config.minimum_depth = 1;
 422         bob_config.channel_options.announced_channel = true;
 423         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 424         let chanmon_cfgs = create_chanmon_cfgs(2);
 425         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 426         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 427         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 428         *nodes[0].connect_style.borrow_mut() = connect_style;
 429
 430         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
 431         mine_transaction(&nodes[1], &tx);
 432         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()));
 433
 434         mine_transaction(&nodes[0], &tx);
 435         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 436         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 437
 438         for node in nodes {
 439                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
 440                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
 441                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
 442         }
 443 }
 444 #[test]
 445 fn test_1_conf_open() {
 446         do_test_1_conf_open(ConnectStyle::BestBlockFirst);
 447         do_test_1_conf_open(ConnectStyle::TransactionsFirst);
 448         do_test_1_conf_open(ConnectStyle::FullBlockViaListen);
 449 }
 450
 451 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 452         // Previously, we had issues deserializing channels when we hadn't connected the first block
 453         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 454         // serialization round-trips and simply do steps towards opening a channel and then drop the
 455         // Node objects.
 456
 457         let chanmon_cfgs = create_chanmon_cfgs(2);
 458         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 459         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 460         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 461
 462         if steps & 0b1000_0000 != 0{
 463                 let block = Block {
 464                         header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 465                         txdata: vec![],
 466                 };
 467                 connect_block(&nodes[0], &block);
 468                 connect_block(&nodes[1], &block);
 469         }
 470
 471         if steps & 0x0f == 0 { return; }
 472         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 473         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 474
 475         if steps & 0x0f == 1 { return; }
 476         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
 477         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 478
 479         if steps & 0x0f == 2 { return; }
 480         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
 481
 482         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 483
 484         if steps & 0x0f == 3 { return; }
 485         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
 486         check_added_monitors!(nodes[0], 0);
 487         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 488
 489         if steps & 0x0f == 4 { return; }
 490         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 491         {
 492                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 493                 assert_eq!(added_monitors.len(), 1);
 494                 assert_eq!(added_monitors[0].0, funding_output);
 495                 added_monitors.clear();
 496         }
 497         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 498
 499         if steps & 0x0f == 5 { return; }
 500         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 501         {
 502                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 503                 assert_eq!(added_monitors.len(), 1);
 504                 assert_eq!(added_monitors[0].0, funding_output);
 505                 added_monitors.clear();
 506         }
 507
 508         let events_4 = nodes[0].node.get_and_clear_pending_events();
 509         assert_eq!(events_4.len(), 0);
 510
 511         if steps & 0x0f == 6 { return; }
 512         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
 513
 514         if steps & 0x0f == 7 { return; }
 515         confirm_transaction_at(&nodes[0], &tx, 2);
 516         connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
 517         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 518 }
 519
 520 #[test]
 521 fn test_sanity_on_in_flight_opens() {
 522         do_test_sanity_on_in_flight_opens(0);
 523         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 524         do_test_sanity_on_in_flight_opens(1);
 525         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 526         do_test_sanity_on_in_flight_opens(2);
 527         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 528         do_test_sanity_on_in_flight_opens(3);
 529         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 530         do_test_sanity_on_in_flight_opens(4);
 531         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 532         do_test_sanity_on_in_flight_opens(5);
 533         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 534         do_test_sanity_on_in_flight_opens(6);
 535         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 536         do_test_sanity_on_in_flight_opens(7);
 537         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 538         do_test_sanity_on_in_flight_opens(8);
 539         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 540 }
 541
 542 #[test]
 543 fn test_update_fee_vanilla() {
 544         let chanmon_cfgs = create_chanmon_cfgs(2);
 545         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 546         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 547         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 548         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 549
 550         {
 551                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 552                 *feerate_lock += 25;
 553         }
 554         nodes[0].node.timer_tick_occurred();
 555         check_added_monitors!(nodes[0], 1);
 556
 557         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 558         assert_eq!(events_0.len(), 1);
 559         let (update_msg, commitment_signed) = match events_0[0] {
 560                         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 } } => {
 561                         (update_fee.as_ref(), commitment_signed)
 562                 },
 563                 _ => panic!("Unexpected event"),
 564         };
 565         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 566
 567         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 568         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 569         check_added_monitors!(nodes[1], 1);
 570
 571         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 572         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 573         check_added_monitors!(nodes[0], 1);
 574
 575         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 576         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 577         // No commitment_signed so get_event_msg's assert(len == 1) passes
 578         check_added_monitors!(nodes[0], 1);
 579
 580         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 581         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 582         check_added_monitors!(nodes[1], 1);
 583 }
 584
 585 #[test]
 586 fn test_update_fee_that_funder_cannot_afford() {
 587         let chanmon_cfgs = create_chanmon_cfgs(2);
 588         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 589         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 590         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 591         let channel_value = 1888;
 592         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
 593         let channel_id = chan.2;
 594
 595         let feerate = 260;
 596         {
 597                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 598                 *feerate_lock = feerate;
 599         }
 600         nodes[0].node.timer_tick_occurred();
 601         check_added_monitors!(nodes[0], 1);
 602         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 603
 604         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 605
 606         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 607
 608         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 609         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 610         {
 611                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 612
 613                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 614                 let num_htlcs = commitment_tx.output.len() - 2;
 615                 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 616                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 617                 actual_fee = channel_value - actual_fee;
 618                 assert_eq!(total_fee, actual_fee);
 619         }
 620
 621         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 622         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 623         {
 624                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 625                 *feerate_lock = feerate + 2;
 626         }
 627         nodes[0].node.timer_tick_occurred();
 628         check_added_monitors!(nodes[0], 1);
 629
 630         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 631
 632         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 633
 634         //While producing the commitment_signed response after handling a received update_fee request the
 635         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 636         //Should produce and error.
 637         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 638         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 639         check_added_monitors!(nodes[1], 1);
 640         check_closed_broadcast!(nodes[1], true);
 641         check_closed_event!(nodes[1], 1);
 642 }
 643
 644 #[test]
 645 fn test_update_fee_with_fundee_update_add_htlc() {
 646         let chanmon_cfgs = create_chanmon_cfgs(2);
 647         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 648         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 649         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 650         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 651         let logger = test_utils::TestLogger::new();
 652
 653         // balancing
 654         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 655
 656         {
 657                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 658                 *feerate_lock += 20;
 659         }
 660         nodes[0].node.timer_tick_occurred();
 661         check_added_monitors!(nodes[0], 1);
 662
 663         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 664         assert_eq!(events_0.len(), 1);
 665         let (update_msg, commitment_signed) = match events_0[0] {
 666                         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 } } => {
 667                         (update_fee.as_ref(), commitment_signed)
 668                 },
 669                 _ => panic!("Unexpected event"),
 670         };
 671         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 672         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 673         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 674         check_added_monitors!(nodes[1], 1);
 675
 676         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 677         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 678         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 800000, TEST_FINAL_CLTV, &logger).unwrap();
 679
 680         // nothing happens since node[1] is in AwaitingRemoteRevoke
 681         nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
 682         {
 683                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 684                 assert_eq!(added_monitors.len(), 0);
 685                 added_monitors.clear();
 686         }
 687         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 688         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 689         // node[1] has nothing to do
 690
 691         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 692         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 693         check_added_monitors!(nodes[0], 1);
 694
 695         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 696         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 697         // No commitment_signed so get_event_msg's assert(len == 1) passes
 698         check_added_monitors!(nodes[0], 1);
 699         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 700         check_added_monitors!(nodes[1], 1);
 701         // AwaitingRemoteRevoke ends here
 702
 703         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 704         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 705         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 706         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 707         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 708         assert_eq!(commitment_update.update_fee.is_none(), true);
 709
 710         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 711         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 712         check_added_monitors!(nodes[0], 1);
 713         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 714
 715         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 716         check_added_monitors!(nodes[1], 1);
 717         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 718
 719         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 720         check_added_monitors!(nodes[1], 1);
 721         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 722         // No commitment_signed so get_event_msg's assert(len == 1) passes
 723
 724         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 725         check_added_monitors!(nodes[0], 1);
 726         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 727
 728         let events = nodes[0].node.get_and_clear_pending_events();
 729         expect_pending_htlcs_forwardable!(nodes[0], events);
 730
 731         let events = nodes[0].node.get_and_clear_pending_events();
 732         assert_eq!(events.len(), 1);
 733         match events[0] {
 734                 Event::PaymentReceived { .. } => { },
 735                 _ => panic!("Unexpected event"),
 736         };
 737
 738         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
 739
 740         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
 741         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
 742         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 743         check_closed_event!(nodes[0], 1);
 744         check_closed_event!(nodes[1], 1);
 745 }
 746
 747 #[test]
 748 fn test_update_fee() {
 749         let chanmon_cfgs = create_chanmon_cfgs(2);
 750         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 751         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 752         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 753         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 754         let channel_id = chan.2;
 755
 756         // A                                        B
 757         // (1) update_fee/commitment_signed      ->
 758         //                                       <- (2) revoke_and_ack
 759         //                                       .- send (3) commitment_signed
 760         // (4) update_fee/commitment_signed      ->
 761         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 762         //                                       <- (3) commitment_signed delivered
 763         // send (6) revoke_and_ack               -.
 764         //                                       <- (5) deliver revoke_and_ack
 765         // (6) deliver revoke_and_ack            ->
 766         //                                       .- send (7) commitment_signed in response to (4)
 767         //                                       <- (7) deliver commitment_signed
 768         // revoke_and_ack                        ->
 769
 770         // Create and deliver (1)...
 771         let feerate;
 772         {
 773                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 774                 feerate = *feerate_lock;
 775                 *feerate_lock = feerate + 20;
 776         }
 777         nodes[0].node.timer_tick_occurred();
 778         check_added_monitors!(nodes[0], 1);
 779
 780         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 781         assert_eq!(events_0.len(), 1);
 782         let (update_msg, commitment_signed) = match events_0[0] {
 783                         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 } } => {
 784                         (update_fee.as_ref(), commitment_signed)
 785                 },
 786                 _ => panic!("Unexpected event"),
 787         };
 788         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 789
 790         // Generate (2) and (3):
 791         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 792         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 793         check_added_monitors!(nodes[1], 1);
 794
 795         // Deliver (2):
 796         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 797         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 798         check_added_monitors!(nodes[0], 1);
 799
 800         // Create and deliver (4)...
 801         {
 802                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 803                 *feerate_lock = feerate + 30;
 804         }
 805         nodes[0].node.timer_tick_occurred();
 806         check_added_monitors!(nodes[0], 1);
 807         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 808         assert_eq!(events_0.len(), 1);
 809         let (update_msg, commitment_signed) = match events_0[0] {
 810                         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 } } => {
 811                         (update_fee.as_ref(), commitment_signed)
 812                 },
 813                 _ => panic!("Unexpected event"),
 814         };
 815
 816         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 817         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 818         check_added_monitors!(nodes[1], 1);
 819         // ... creating (5)
 820         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 821         // No commitment_signed so get_event_msg's assert(len == 1) passes
 822
 823         // Handle (3), creating (6):
 824         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 825         check_added_monitors!(nodes[0], 1);
 826         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 827         // No commitment_signed so get_event_msg's assert(len == 1) passes
 828
 829         // Deliver (5):
 830         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 831         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 832         check_added_monitors!(nodes[0], 1);
 833
 834         // Deliver (6), creating (7):
 835         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 836         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 837         assert!(commitment_update.update_add_htlcs.is_empty());
 838         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 839         assert!(commitment_update.update_fail_htlcs.is_empty());
 840         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 841         assert!(commitment_update.update_fee.is_none());
 842         check_added_monitors!(nodes[1], 1);
 843
 844         // Deliver (7)
 845         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 846         check_added_monitors!(nodes[0], 1);
 847         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 848         // No commitment_signed so get_event_msg's assert(len == 1) passes
 849
 850         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 851         check_added_monitors!(nodes[1], 1);
 852         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 853
 854         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 855         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 856         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 857         check_closed_event!(nodes[0], 1);
 858         check_closed_event!(nodes[1], 1);
 859 }
 860
 861 #[test]
 862 fn fake_network_test() {
 863         // Simple test which builds a network of ChannelManagers, connects them to each other, and
 864         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
 865         let chanmon_cfgs = create_chanmon_cfgs(4);
 866         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
 867         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
 868         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
 869
 870         // Create some initial channels
 871         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 872         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 873         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
 874
 875         // Rebalance the network a bit by relaying one payment through all the channels...
 876         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
 877         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
 878         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
 879         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
 880
 881         // Send some more payments
 882         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
 883         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
 884         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
 885
 886         // Test failure packets
 887         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
 888         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
 889
 890         // Add a new channel that skips 3
 891         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
 892
 893         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
 894         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
 895         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
 896         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
 897         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
 898         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
 899         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
 900
 901         // Do some rebalance loop payments, simultaneously
 902         let mut hops = Vec::with_capacity(3);
 903         hops.push(RouteHop {
 904                 pubkey: nodes[2].node.get_our_node_id(),
 905                 node_features: NodeFeatures::empty(),
 906                 short_channel_id: chan_2.0.contents.short_channel_id,
 907                 channel_features: ChannelFeatures::empty(),
 908                 fee_msat: 0,
 909                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
 910         });
 911         hops.push(RouteHop {
 912                 pubkey: nodes[3].node.get_our_node_id(),
 913                 node_features: NodeFeatures::empty(),
 914                 short_channel_id: chan_3.0.contents.short_channel_id,
 915                 channel_features: ChannelFeatures::empty(),
 916                 fee_msat: 0,
 917                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
 918         });
 919         hops.push(RouteHop {
 920                 pubkey: nodes[1].node.get_our_node_id(),
 921                 node_features: NodeFeatures::known(),
 922                 short_channel_id: chan_4.0.contents.short_channel_id,
 923                 channel_features: ChannelFeatures::known(),
 924                 fee_msat: 1000000,
 925                 cltv_expiry_delta: TEST_FINAL_CLTV,
 926         });
 927         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;
 928         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;
 929         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
 930
 931         let mut hops = Vec::with_capacity(3);
 932         hops.push(RouteHop {
 933                 pubkey: nodes[3].node.get_our_node_id(),
 934                 node_features: NodeFeatures::empty(),
 935                 short_channel_id: chan_4.0.contents.short_channel_id,
 936                 channel_features: ChannelFeatures::empty(),
 937                 fee_msat: 0,
 938                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
 939         });
 940         hops.push(RouteHop {
 941                 pubkey: nodes[2].node.get_our_node_id(),
 942                 node_features: NodeFeatures::empty(),
 943                 short_channel_id: chan_3.0.contents.short_channel_id,
 944                 channel_features: ChannelFeatures::empty(),
 945                 fee_msat: 0,
 946                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
 947         });
 948         hops.push(RouteHop {
 949                 pubkey: nodes[1].node.get_our_node_id(),
 950                 node_features: NodeFeatures::known(),
 951                 short_channel_id: chan_2.0.contents.short_channel_id,
 952                 channel_features: ChannelFeatures::known(),
 953                 fee_msat: 1000000,
 954                 cltv_expiry_delta: TEST_FINAL_CLTV,
 955         });
 956         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;
 957         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;
 958         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
 959
 960         // Claim the rebalances...
 961         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
 962         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
 963
 964         // Add a duplicate new channel from 2 to 4
 965         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
 966
 967         // Send some payments across both channels
 968         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
 969         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
 970         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
 971
 972
 973         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
 974         let events = nodes[0].node.get_and_clear_pending_msg_events();
 975         assert_eq!(events.len(), 0);
 976         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);
 977
 978         //TODO: Test that routes work again here as we've been notified that the channel is full
 979
 980         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
 981         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
 982         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
 983
 984         // Close down the channels...
 985         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
 986         check_closed_event!(nodes[0], 1);
 987         check_closed_event!(nodes[1], 1);
 988         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
 989         check_closed_event!(nodes[1], 1);
 990         check_closed_event!(nodes[2], 1);
 991         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
 992         check_closed_event!(nodes[2], 1);
 993         check_closed_event!(nodes[3], 1);
 994         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
 995         check_closed_event!(nodes[1], 1);
 996         check_closed_event!(nodes[3], 1);
 997         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
 998         check_closed_event!(nodes[1], 1);
 999         check_closed_event!(nodes[3], 1);
1000 }
1001
1002 #[test]
1003 fn holding_cell_htlc_counting() {
1004         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1005         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1006         // commitment dance rounds.
1007         let chanmon_cfgs = create_chanmon_cfgs(3);
1008         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1009         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1010         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1011         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1012         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1013         let logger = test_utils::TestLogger::new();
1014
1015         let mut payments = Vec::new();
1016         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1017                 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
1018                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1019                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1020                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
1021                 payments.push((payment_preimage, payment_hash));
1022         }
1023         check_added_monitors!(nodes[1], 1);
1024
1025         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1026         assert_eq!(events.len(), 1);
1027         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1028         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1029
1030         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1031         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1032         // another HTLC.
1033         let (_, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[2]);
1034         {
1035                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1036                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1037                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable { ref err },
1038                         assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1039                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1040                 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1041         }
1042
1043         // This should also be true if we try to forward a payment.
1044         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[2]);
1045         {
1046                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1047                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1048                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1049                 check_added_monitors!(nodes[0], 1);
1050         }
1051
1052         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1053         assert_eq!(events.len(), 1);
1054         let payment_event = SendEvent::from_event(events.pop().unwrap());
1055         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1056
1057         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1058         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1059         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1060         // fails), the second will process the resulting failure and fail the HTLC backward.
1061         let events = nodes[1].node.get_and_clear_pending_events();
1062         expect_pending_htlcs_forwardable!(nodes[1], events);
1063         let events = nodes[1].node.get_and_clear_pending_events();
1064         expect_pending_htlcs_forwardable!(nodes[1], events);
1065         check_added_monitors!(nodes[1], 1);
1066
1067         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1068         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1069         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1070
1071         expect_payment_failed_with_update!(nodes[0], payment_hash_2, false, chan_2.0.contents.short_channel_id, false);
1072
1073         // Now forward all the pending HTLCs and claim them back
1074         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1075         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1076         check_added_monitors!(nodes[2], 1);
1077
1078         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1079         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1080         check_added_monitors!(nodes[1], 1);
1081         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1082
1083         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1084         check_added_monitors!(nodes[1], 1);
1085         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1086
1087         for ref update in as_updates.update_add_htlcs.iter() {
1088                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1089         }
1090         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1091         check_added_monitors!(nodes[2], 1);
1092         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1093         check_added_monitors!(nodes[2], 1);
1094         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1095
1096         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1097         check_added_monitors!(nodes[1], 1);
1098         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1099         check_added_monitors!(nodes[1], 1);
1100         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1101
1102         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1103         check_added_monitors!(nodes[2], 1);
1104
1105         let events = nodes[2].node.get_and_clear_pending_events();
1106         expect_pending_htlcs_forwardable!(nodes[2], events);
1107
1108         let events = nodes[2].node.get_and_clear_pending_events();
1109         assert_eq!(events.len(), payments.len());
1110         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1111                 match event {
1112                         &Event::PaymentReceived { ref payment_hash, .. } => {
1113                                 assert_eq!(*payment_hash, *hash);
1114                         },
1115                         _ => panic!("Unexpected event"),
1116                 };
1117         }
1118
1119         for (preimage, _) in payments.drain(..) {
1120                 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1121         }
1122
1123         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1124 }
1125
1126 #[test]
1127 fn duplicate_htlc_test() {
1128         // Test that we accept duplicate payment_hash HTLCs across the network and that
1129         // claiming/failing them are all separate and don't affect each other
1130         let chanmon_cfgs = create_chanmon_cfgs(6);
1131         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1132         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1133         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1134
1135         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1136         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1137         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1138         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1139         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1140         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1141
1142         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1143
1144         *nodes[0].network_payment_count.borrow_mut() -= 1;
1145         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1146
1147         *nodes[0].network_payment_count.borrow_mut() -= 1;
1148         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1149
1150         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1151         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1152         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1153 }
1154
1155 #[test]
1156 fn test_duplicate_htlc_different_direction_onchain() {
1157         // Test that ChannelMonitor doesn't generate 2 preimage txn
1158         // when we have 2 HTLCs with same preimage that go across a node
1159         // in opposite directions, even with the same payment secret.
1160         let chanmon_cfgs = create_chanmon_cfgs(2);
1161         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1162         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1163         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1164
1165         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1166         let logger = test_utils::TestLogger::new();
1167
1168         // balancing
1169         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1170
1171         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1172
1173         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1174         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 800_000, TEST_FINAL_CLTV, &logger).unwrap();
1175         let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
1176         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1177
1178         // Provide preimage to node 0 by claiming payment
1179         nodes[0].node.claim_funds(payment_preimage);
1180         check_added_monitors!(nodes[0], 1);
1181
1182         // Broadcast node 1 commitment txn
1183         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1184
1185         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1186         let mut has_both_htlcs = 0; // check htlcs match ones committed
1187         for outp in remote_txn[0].output.iter() {
1188                 if outp.value == 800_000 / 1000 {
1189                         has_both_htlcs += 1;
1190                 } else if outp.value == 900_000 / 1000 {
1191                         has_both_htlcs += 1;
1192                 }
1193         }
1194         assert_eq!(has_both_htlcs, 2);
1195
1196         mine_transaction(&nodes[0], &remote_txn[0]);
1197         check_added_monitors!(nodes[0], 1);
1198         check_closed_event!(nodes[0], 1);
1199         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
1200
1201         // Check we only broadcast 1 timeout tx
1202         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1203         assert_eq!(claim_txn.len(), 8);
1204         assert_eq!(claim_txn[1], claim_txn[4]);
1205         assert_eq!(claim_txn[2], claim_txn[5]);
1206         check_spends!(claim_txn[1], chan_1.3);
1207         check_spends!(claim_txn[2], claim_txn[1]);
1208         check_spends!(claim_txn[7], claim_txn[1]);
1209
1210         assert_eq!(claim_txn[0].input.len(), 1);
1211         assert_eq!(claim_txn[3].input.len(), 1);
1212         assert_eq!(claim_txn[0].input[0].previous_output, claim_txn[3].input[0].previous_output);
1213
1214         assert_eq!(claim_txn[0].input.len(), 1);
1215         assert_eq!(claim_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1216         check_spends!(claim_txn[0], remote_txn[0]);
1217         assert_eq!(remote_txn[0].output[claim_txn[0].input[0].previous_output.vout as usize].value, 800);
1218         assert_eq!(claim_txn[6].input.len(), 1);
1219         assert_eq!(claim_txn[6].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1220         check_spends!(claim_txn[6], remote_txn[0]);
1221         assert_eq!(remote_txn[0].output[claim_txn[6].input[0].previous_output.vout as usize].value, 900);
1222
1223         let events = nodes[0].node.get_and_clear_pending_msg_events();
1224         assert_eq!(events.len(), 3);
1225         for e in events {
1226                 match e {
1227                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1228                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1229                                 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1230                                 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1231                         },
1232                         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, .. } } => {
1233                                 assert!(update_add_htlcs.is_empty());
1234                                 assert!(update_fail_htlcs.is_empty());
1235                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1236                                 assert!(update_fail_malformed_htlcs.is_empty());
1237                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1238                         },
1239                         _ => panic!("Unexpected event"),
1240                 }
1241         }
1242 }
1243
1244 #[test]
1245 fn test_basic_channel_reserve() {
1246         let chanmon_cfgs = create_chanmon_cfgs(2);
1247         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1248         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1249         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1250         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1251         let logger = test_utils::TestLogger::new();
1252
1253         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1254         let channel_reserve = chan_stat.channel_reserve_msat;
1255
1256         // The 2* and +1 are for the fee spike reserve.
1257         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
1258         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1259         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1260         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1261         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1262         let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).err().unwrap();
1263         match err {
1264                 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1265                         match &fails[0] {
1266                                 &APIError::ChannelUnavailable{ref err} =>
1267                                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1268                                 _ => panic!("Unexpected error variant"),
1269                         }
1270                 },
1271                 _ => panic!("Unexpected error variant"),
1272         }
1273         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1274         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);
1275
1276         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1277 }
1278
1279 #[test]
1280 fn test_fee_spike_violation_fails_htlc() {
1281         let chanmon_cfgs = create_chanmon_cfgs(2);
1282         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1283         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1284         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1285         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1286
1287         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1288         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1289         let secp_ctx = Secp256k1::new();
1290         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1291
1292         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1293
1294         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1295         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height, &None).unwrap();
1296         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1297         let msg = msgs::UpdateAddHTLC {
1298                 channel_id: chan.2,
1299                 htlc_id: 0,
1300                 amount_msat: htlc_msat,
1301                 payment_hash: payment_hash,
1302                 cltv_expiry: htlc_cltv,
1303                 onion_routing_packet: onion_packet,
1304         };
1305
1306         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1307
1308         // Now manually create the commitment_signed message corresponding to the update_add
1309         // nodes[0] just sent. In the code for construction of this message, "local" refers
1310         // to the sender of the message, and "remote" refers to the receiver.
1311
1312         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1313
1314         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1315
1316         // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1317         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1318         let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point, local_funding) = {
1319                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1320                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1321                 let chan_signer = local_chan.get_signer();
1322                 // Make the signer believe we validated another commitment, so we can release the secret
1323                 chan_signer.get_enforcement_state().last_holder_commitment -= 1;
1324
1325                 let pubkeys = chan_signer.pubkeys();
1326                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1327                  chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1328                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx),
1329                  chan_signer.pubkeys().funding_pubkey)
1330         };
1331         let (remote_delayed_payment_basepoint, remote_htlc_basepoint, remote_point, remote_funding) = {
1332                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1333                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1334                 let chan_signer = remote_chan.get_signer();
1335                 let pubkeys = chan_signer.pubkeys();
1336                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1337                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx),
1338                  chan_signer.pubkeys().funding_pubkey)
1339         };
1340
1341         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1342         let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1343                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1344
1345         // Build the remote commitment transaction so we can sign it, and then later use the
1346         // signature for the commitment_signed message.
1347         let local_chan_balance = 1313;
1348
1349         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1350                 offered: false,
1351                 amount_msat: 3460001,
1352                 cltv_expiry: htlc_cltv,
1353                 payment_hash,
1354                 transaction_output_index: Some(1),
1355         };
1356
1357         let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1358
1359         let res = {
1360                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1361                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1362                 let local_chan_signer = local_chan.get_signer();
1363                 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1364                         commitment_number,
1365                         95000,
1366                         local_chan_balance,
1367                         false, local_funding, remote_funding,
1368                         commit_tx_keys.clone(),
1369                         feerate_per_kw,
1370                         &mut vec![(accepted_htlc_info, ())],
1371                         &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1372                 );
1373                 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1374         };
1375
1376         let commit_signed_msg = msgs::CommitmentSigned {
1377                 channel_id: chan.2,
1378                 signature: res.0,
1379                 htlc_signatures: res.1
1380         };
1381
1382         // Send the commitment_signed message to the nodes[1].
1383         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1384         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1385
1386         // Send the RAA to nodes[1].
1387         let raa_msg = msgs::RevokeAndACK {
1388                 channel_id: chan.2,
1389                 per_commitment_secret: local_secret,
1390                 next_per_commitment_point: next_local_point
1391         };
1392         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1393
1394         let events = nodes[1].node.get_and_clear_pending_msg_events();
1395         assert_eq!(events.len(), 1);
1396         // Make sure the HTLC failed in the way we expect.
1397         match events[0] {
1398                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1399                         assert_eq!(update_fail_htlcs.len(), 1);
1400                         update_fail_htlcs[0].clone()
1401                 },
1402                 _ => panic!("Unexpected event"),
1403         };
1404         nodes[1].logger.assert_log("lightning::ln::channel".to_string(),
1405                 format!("Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", ::hex::encode(raa_msg.channel_id)), 1);
1406
1407         check_added_monitors!(nodes[1], 2);
1408 }
1409
1410 #[test]
1411 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1412         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1413         // Set the fee rate for the channel very high, to the point where the fundee
1414         // sending any above-dust amount would result in a channel reserve violation.
1415         // In this test we check that we would be prevented from sending an HTLC in
1416         // this situation.
1417         let feerate_per_kw = 253;
1418         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1419         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1420         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1421         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1422         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1423
1424         let mut push_amt = 100_000_000;
1425         push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000 * 1000;
1426         push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1427
1428         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, push_amt, InitFeatures::known(), InitFeatures::known());
1429
1430         // Sending exactly enough to hit the reserve amount should be accepted
1431         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], 1_000_000);
1432
1433         // However one more HTLC should be significantly over the reserve amount and fail.
1434         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1_000_000);
1435         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1436                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1437         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1438         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);
1439 }
1440
1441 #[test]
1442 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1443         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1444         // Set the fee rate for the channel very high, to the point where the funder
1445         // receiving 1 update_add_htlc would result in them closing the channel due
1446         // to channel reserve violation. This close could also happen if the fee went
1447         // up a more realistic amount, but many HTLCs were outstanding at the time of
1448         // the update_add_htlc.
1449         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1450         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1451         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1452         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1453         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1454         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1455
1456         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1457         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1458         let secp_ctx = Secp256k1::new();
1459         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1460         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1461         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1462         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height, &None).unwrap();
1463         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1464         let msg = msgs::UpdateAddHTLC {
1465                 channel_id: chan.2,
1466                 htlc_id: 1,
1467                 amount_msat: htlc_msat + 1,
1468                 payment_hash: payment_hash,
1469                 cltv_expiry: htlc_cltv,
1470                 onion_routing_packet: onion_packet,
1471         };
1472
1473         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1474         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1475         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);
1476         assert_eq!(nodes[0].node.list_channels().len(), 0);
1477         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1478         assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1479         check_added_monitors!(nodes[0], 1);
1480         check_closed_event!(nodes[0], 1);
1481 }
1482
1483 #[test]
1484 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1485         // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1486         // calculating our commitment transaction fee (this was previously broken).
1487         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1488         let feerate_per_kw = 253;
1489         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1490         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1491
1492         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1493         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1494         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1495
1496         // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1497         // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1498         // transaction fee with 0 HTLCs (183 sats)).
1499         let mut push_amt = 100_000_000;
1500         push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT) / 1000 * 1000;
1501         push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1502         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, push_amt, InitFeatures::known(), InitFeatures::known());
1503
1504         let dust_amt = crate::ln::channel::MIN_DUST_LIMIT_SATOSHIS * 1000
1505                 + feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000 * 1000 - 1;
1506         // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1507         // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1508         // commitment transaction fee.
1509         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1510
1511         // One more than the dust amt should fail, however.
1512         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], dust_amt + 1);
1513         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1514                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1515 }
1516
1517 #[test]
1518 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1519         // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1520         // calculating our counterparty's commitment transaction fee (this was previously broken).
1521         let chanmon_cfgs = create_chanmon_cfgs(2);
1522         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1523         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1524         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1525         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1526
1527         let payment_amt = 46000; // Dust amount
1528         // In the previous code, these first four payments would succeed.
1529         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1530         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1531         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1532         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1533
1534         // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1535         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1536         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1537         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1538         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1539         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1540
1541         // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1542         // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1543         // transaction fee and therefore perceived this next payment as a channel reserve violation.
1544         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1545 }
1546
1547 #[test]
1548 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1549         let chanmon_cfgs = create_chanmon_cfgs(3);
1550         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1551         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1552         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1553         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1554         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1555
1556         let feemsat = 239;
1557         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1558         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1559         let feerate = get_feerate!(nodes[0], chan.2);
1560
1561         // Add a 2* and +1 for the fee spike reserve.
1562         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1563         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;
1564         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1565
1566         // Add a pending HTLC.
1567         let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1568         let payment_event_1 = {
1569                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1570                 check_added_monitors!(nodes[0], 1);
1571
1572                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1573                 assert_eq!(events.len(), 1);
1574                 SendEvent::from_event(events.remove(0))
1575         };
1576         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1577
1578         // Attempt to trigger a channel reserve violation --> payment failure.
1579         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1580         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;
1581         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1582         let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1583
1584         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1585         let secp_ctx = Secp256k1::new();
1586         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1587         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1588         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1589         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height, &None).unwrap();
1590         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1591         let msg = msgs::UpdateAddHTLC {
1592                 channel_id: chan.2,
1593                 htlc_id: 1,
1594                 amount_msat: htlc_msat + 1,
1595                 payment_hash: our_payment_hash_1,
1596                 cltv_expiry: htlc_cltv,
1597                 onion_routing_packet: onion_packet,
1598         };
1599
1600         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1601         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1602         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1603         assert_eq!(nodes[1].node.list_channels().len(), 1);
1604         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1605         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1606         check_added_monitors!(nodes[1], 1);
1607         check_closed_event!(nodes[1], 1);
1608 }
1609
1610 #[test]
1611 fn test_inbound_outbound_capacity_is_not_zero() {
1612         let chanmon_cfgs = create_chanmon_cfgs(2);
1613         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1614         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1615         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1616         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1617         let channels0 = node_chanmgrs[0].list_channels();
1618         let channels1 = node_chanmgrs[1].list_channels();
1619         assert_eq!(channels0.len(), 1);
1620         assert_eq!(channels1.len(), 1);
1621
1622         let reserve = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100000);
1623         assert_eq!(channels0[0].inbound_capacity_msat, 95000000 - reserve*1000);
1624         assert_eq!(channels1[0].outbound_capacity_msat, 95000000 - reserve*1000);
1625
1626         assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1627         assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1628 }
1629
1630 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1631         (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1632 }
1633
1634 #[test]
1635 fn test_channel_reserve_holding_cell_htlcs() {
1636         let chanmon_cfgs = create_chanmon_cfgs(3);
1637         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1638         // When this test was written, the default base fee floated based on the HTLC count.
1639         // It is now fixed, so we simply set the fee to the expected value here.
1640         let mut config = test_default_channel_config();
1641         config.channel_options.forwarding_fee_base_msat = 239;
1642         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
1643         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1644         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1645         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1646
1647         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1648         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1649
1650         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1651         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1652
1653         macro_rules! expect_forward {
1654                 ($node: expr) => {{
1655                         let mut events = $node.node.get_and_clear_pending_msg_events();
1656                         assert_eq!(events.len(), 1);
1657                         check_added_monitors!($node, 1);
1658                         let payment_event = SendEvent::from_event(events.remove(0));
1659                         payment_event
1660                 }}
1661         }
1662
1663         let feemsat = 239; // set above
1664         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1665         let feerate = get_feerate!(nodes[0], chan_1.2);
1666
1667         let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1668
1669         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1670         {
1671                 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1672                 route.paths[0].last_mut().unwrap().fee_msat += 1;
1673                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1674                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1675                         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)));
1676                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1677                 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);
1678         }
1679
1680         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1681         // nodes[0]'s wealth
1682         loop {
1683                 let amt_msat = recv_value_0 + total_fee_msat;
1684                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1685                 // Also, ensure that each payment has enough to be over the dust limit to
1686                 // ensure it'll be included in each commit tx fee calculation.
1687                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1688                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1689                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1690                         break;
1691                 }
1692                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1693
1694                 let (stat01_, stat11_, stat12_, stat22_) = (
1695                         get_channel_value_stat!(nodes[0], chan_1.2),
1696                         get_channel_value_stat!(nodes[1], chan_1.2),
1697                         get_channel_value_stat!(nodes[1], chan_2.2),
1698                         get_channel_value_stat!(nodes[2], chan_2.2),
1699                 );
1700
1701                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1702                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1703                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1704                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1705                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1706         }
1707
1708         // adding pending output.
1709         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1710         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1711         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1712         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1713         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1714         // cases where 1 msat over X amount will cause a payment failure, but anything less than
1715         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1716         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1717         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1718         // policy.
1719         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1720         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1721         let amt_msat_1 = recv_value_1 + total_fee_msat;
1722
1723         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);
1724         let payment_event_1 = {
1725                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1726                 check_added_monitors!(nodes[0], 1);
1727
1728                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1729                 assert_eq!(events.len(), 1);
1730                 SendEvent::from_event(events.remove(0))
1731         };
1732         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1733
1734         // channel reserve test with htlc pending output > 0
1735         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1736         {
1737                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
1738                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1739                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1740                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1741         }
1742
1743         // split the rest to test holding cell
1744         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1745         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
1746         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
1747         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
1748         {
1749                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1750                 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);
1751         }
1752
1753         // now see if they go through on both sides
1754         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);
1755         // but this will stuck in the holding cell
1756         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
1757         check_added_monitors!(nodes[0], 0);
1758         let events = nodes[0].node.get_and_clear_pending_events();
1759         assert_eq!(events.len(), 0);
1760
1761         // test with outbound holding cell amount > 0
1762         {
1763                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
1764                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1765                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1766                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1767                 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);
1768         }
1769
1770         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);
1771         // this will also stuck in the holding cell
1772         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
1773         check_added_monitors!(nodes[0], 0);
1774         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1775         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1776
1777         // flush the pending htlc
1778         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1779         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1780         check_added_monitors!(nodes[1], 1);
1781
1782         // the pending htlc should be promoted to committed
1783         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1784         check_added_monitors!(nodes[0], 1);
1785         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1786
1787         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1788         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1789         // No commitment_signed so get_event_msg's assert(len == 1) passes
1790         check_added_monitors!(nodes[0], 1);
1791
1792         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1793         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1794         check_added_monitors!(nodes[1], 1);
1795
1796         let events = nodes[1].node.get_and_clear_pending_events();
1797         expect_pending_htlcs_forwardable!(nodes[1], events);
1798
1799         let ref payment_event_11 = expect_forward!(nodes[1]);
1800         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1801         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1802
1803         let events = nodes[2].node.get_and_clear_pending_events();
1804         expect_pending_htlcs_forwardable!(nodes[2], events);
1805         expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
1806
1807         // flush the htlcs in the holding cell
1808         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1809         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1810         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1811         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1812         let events = nodes[1].node.get_and_clear_pending_events();
1813         expect_pending_htlcs_forwardable!(nodes[1], events);
1814
1815         let ref payment_event_3 = expect_forward!(nodes[1]);
1816         assert_eq!(payment_event_3.msgs.len(), 2);
1817         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1818         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1819
1820         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1821         let events = nodes[2].node.get_and_clear_pending_events();
1822         expect_pending_htlcs_forwardable!(nodes[2], events);
1823
1824         let events = nodes[2].node.get_and_clear_pending_events();
1825         assert_eq!(events.len(), 2);
1826         match events[0] {
1827                 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1828                         assert_eq!(our_payment_hash_21, *payment_hash);
1829                         assert_eq!(recv_value_21, amt);
1830                         match &purpose {
1831                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1832                                         assert!(payment_preimage.is_none());
1833                                         assert_eq!(our_payment_secret_21, *payment_secret);
1834                                 },
1835                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
1836                         }
1837                 },
1838                 _ => panic!("Unexpected event"),
1839         }
1840         match events[1] {
1841                 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1842                         assert_eq!(our_payment_hash_22, *payment_hash);
1843                         assert_eq!(recv_value_22, amt);
1844                         match &purpose {
1845                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1846                                         assert!(payment_preimage.is_none());
1847                                         assert_eq!(our_payment_secret_22, *payment_secret);
1848                                 },
1849                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
1850                         }
1851                 },
1852                 _ => panic!("Unexpected event"),
1853         }
1854
1855         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
1856         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
1857         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
1858
1859         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
1860         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
1861         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
1862
1863         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
1864         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);
1865         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1866         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1867         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
1868
1869         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1870         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
1871 }
1872
1873 #[test]
1874 fn channel_reserve_in_flight_removes() {
1875         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1876         // can send to its counterparty, but due to update ordering, the other side may not yet have
1877         // considered those HTLCs fully removed.
1878         // This tests that we don't count HTLCs which will not be included in the next remote
1879         // commitment transaction towards the reserve value (as it implies no commitment transaction
1880         // will be generated which violates the remote reserve value).
1881         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1882         // To test this we:
1883         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1884         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1885         //    you only consider the value of the first HTLC, it may not),
1886         //  * start routing a third HTLC from A to B,
1887         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1888         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1889         //  * deliver the first fulfill from B
1890         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1891         //    claim,
1892         //  * deliver A's response CS and RAA.
1893         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1894         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
1895         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1896         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1897         let chanmon_cfgs = create_chanmon_cfgs(2);
1898         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1899         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1900         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1901         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1902         let logger = test_utils::TestLogger::new();
1903
1904         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1905         // Route the first two HTLCs.
1906         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1907         let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1908
1909         // Start routing the third HTLC (this is just used to get everyone in the right state).
1910         let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
1911         let send_1 = {
1912                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1913                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
1914                 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
1915                 check_added_monitors!(nodes[0], 1);
1916                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1917                 assert_eq!(events.len(), 1);
1918                 SendEvent::from_event(events.remove(0))
1919         };
1920
1921         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1922         // initial fulfill/CS.
1923         assert!(nodes[1].node.claim_funds(payment_preimage_1));
1924         check_added_monitors!(nodes[1], 1);
1925         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1926
1927         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1928         // remove the second HTLC when we send the HTLC back from B to A.
1929         assert!(nodes[1].node.claim_funds(payment_preimage_2));
1930         check_added_monitors!(nodes[1], 1);
1931         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1932
1933         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
1934         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
1935         check_added_monitors!(nodes[0], 1);
1936         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1937         let events = nodes[0].node.get_and_clear_pending_events();
1938         expect_payment_sent!(nodes[0], payment_preimage_1, events);
1939
1940         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
1941         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
1942         check_added_monitors!(nodes[1], 1);
1943         // B is already AwaitingRAA, so cant generate a CS here
1944         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1945
1946         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1947         check_added_monitors!(nodes[1], 1);
1948         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1949
1950         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1951         check_added_monitors!(nodes[0], 1);
1952         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1953
1954         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1955         check_added_monitors!(nodes[1], 1);
1956         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1957
1958         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1959         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1960         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1961         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1962         // on-chain as necessary).
1963         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
1964         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
1965         check_added_monitors!(nodes[0], 1);
1966         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1967         let events = nodes[0].node.get_and_clear_pending_events();
1968         expect_payment_sent!(nodes[0], payment_preimage_2, events);
1969
1970         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1971         check_added_monitors!(nodes[1], 1);
1972         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1973
1974         let events = nodes[1].node.get_and_clear_pending_events();
1975         expect_pending_htlcs_forwardable!(nodes[1], events);
1976         expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
1977
1978         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1979         // resolve the second HTLC from A's point of view.
1980         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1981         check_added_monitors!(nodes[0], 1);
1982         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1983
1984         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1985         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1986         let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
1987         let send_2 = {
1988                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1989                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 10000, TEST_FINAL_CLTV, &logger).unwrap();
1990                 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
1991                 check_added_monitors!(nodes[1], 1);
1992                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1993                 assert_eq!(events.len(), 1);
1994                 SendEvent::from_event(events.remove(0))
1995         };
1996
1997         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
1998         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
1999         check_added_monitors!(nodes[0], 1);
2000         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2001
2002         // Now just resolve all the outstanding messages/HTLCs for completeness...
2003
2004         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2005         check_added_monitors!(nodes[1], 1);
2006         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2007
2008         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2009         check_added_monitors!(nodes[1], 1);
2010
2011         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2012         check_added_monitors!(nodes[0], 1);
2013         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2014
2015         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2016         check_added_monitors!(nodes[1], 1);
2017         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2018
2019         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2020         check_added_monitors!(nodes[0], 1);
2021
2022         let events = nodes[0].node.get_and_clear_pending_events();
2023         expect_pending_htlcs_forwardable!(nodes[0], events);
2024         expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2025
2026         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2027         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2028 }
2029
2030 #[test]
2031 fn channel_monitor_network_test() {
2032         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2033         // tests that ChannelMonitor is able to recover from various states.
2034         let chanmon_cfgs = create_chanmon_cfgs(5);
2035         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2036         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2037         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2038
2039         // Create some initial channels
2040         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2041         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2042         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2043         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2044
2045         // Make sure all nodes are at the same starting height
2046         connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2047         connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2048         connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2049         connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2050         connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2051
2052         // Rebalance the network a bit by relaying one payment through all the channels...
2053         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2054         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2055         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2056         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2057
2058         // Simple case with no pending HTLCs:
2059         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2060         check_added_monitors!(nodes[1], 1);
2061         check_closed_broadcast!(nodes[1], false);
2062         {
2063                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2064                 assert_eq!(node_txn.len(), 1);
2065                 mine_transaction(&nodes[0], &node_txn[0]);
2066                 check_added_monitors!(nodes[0], 1);
2067                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2068         }
2069         check_closed_broadcast!(nodes[0], true);
2070         assert_eq!(nodes[0].node.list_channels().len(), 0);
2071         assert_eq!(nodes[1].node.list_channels().len(), 1);
2072         check_closed_event!(nodes[0], 1);
2073         check_closed_event!(nodes[1], 1);
2074
2075         // One pending HTLC is discarded by the force-close:
2076         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2077
2078         // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2079         // broadcasted until we reach the timelock time).
2080         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2081         check_closed_broadcast!(nodes[1], false);
2082         check_added_monitors!(nodes[1], 1);
2083         {
2084                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2085                 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2086                 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2087                 mine_transaction(&nodes[2], &node_txn[0]);
2088                 check_added_monitors!(nodes[2], 1);
2089                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2090         }
2091         check_closed_broadcast!(nodes[2], true);
2092         assert_eq!(nodes[1].node.list_channels().len(), 0);
2093         assert_eq!(nodes[2].node.list_channels().len(), 1);
2094         check_closed_event!(nodes[1], 1);
2095         check_closed_event!(nodes[2], 1);
2096
2097         macro_rules! claim_funds {
2098                 ($node: expr, $prev_node: expr, $preimage: expr) => {
2099                         {
2100                                 assert!($node.node.claim_funds($preimage));
2101                                 check_added_monitors!($node, 1);
2102
2103                                 let events = $node.node.get_and_clear_pending_msg_events();
2104                                 assert_eq!(events.len(), 1);
2105                                 match events[0] {
2106                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2107                                                 assert!(update_add_htlcs.is_empty());
2108                                                 assert!(update_fail_htlcs.is_empty());
2109                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2110                                         },
2111                                         _ => panic!("Unexpected event"),
2112                                 };
2113                         }
2114                 }
2115         }
2116
2117         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2118         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2119         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2120         check_added_monitors!(nodes[2], 1);
2121         check_closed_broadcast!(nodes[2], false);
2122         let node2_commitment_txid;
2123         {
2124                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2125                 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2126                 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2127                 node2_commitment_txid = node_txn[0].txid();
2128
2129                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2130                 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2131                 mine_transaction(&nodes[3], &node_txn[0]);
2132                 check_added_monitors!(nodes[3], 1);
2133                 check_preimage_claim(&nodes[3], &node_txn);
2134         }
2135         check_closed_broadcast!(nodes[3], true);
2136         assert_eq!(nodes[2].node.list_channels().len(), 0);
2137         assert_eq!(nodes[3].node.list_channels().len(), 1);
2138         check_closed_event!(nodes[2], 1);
2139         check_closed_event!(nodes[3], 1);
2140
2141         // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2142         // confusing us in the following tests.
2143         let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2144
2145         // One pending HTLC to time out:
2146         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2147         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2148         // buffer space).
2149
2150         let (close_chan_update_1, close_chan_update_2) = {
2151                 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2152                 let events = nodes[3].node.get_and_clear_pending_msg_events();
2153                 assert_eq!(events.len(), 2);
2154                 let close_chan_update_1 = match events[0] {
2155                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2156                                 msg.clone()
2157                         },
2158                         _ => panic!("Unexpected event"),
2159                 };
2160                 match events[1] {
2161                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2162                                 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2163                         },
2164                         _ => panic!("Unexpected event"),
2165                 }
2166                 check_added_monitors!(nodes[3], 1);
2167
2168                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2169                 {
2170                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2171                         node_txn.retain(|tx| {
2172                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2173                                         false
2174                                 } else { true }
2175                         });
2176                 }
2177
2178                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2179
2180                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2181                 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2182
2183                 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2184                 let events = nodes[4].node.get_and_clear_pending_msg_events();
2185                 assert_eq!(events.len(), 2);
2186                 let close_chan_update_2 = match events[0] {
2187                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2188                                 msg.clone()
2189                         },
2190                         _ => panic!("Unexpected event"),
2191                 };
2192                 match events[1] {
2193                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2194                                 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2195                         },
2196                         _ => panic!("Unexpected event"),
2197                 }
2198                 check_added_monitors!(nodes[4], 1);
2199                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2200
2201                 mine_transaction(&nodes[4], &node_txn[0]);
2202                 check_preimage_claim(&nodes[4], &node_txn);
2203                 (close_chan_update_1, close_chan_update_2)
2204         };
2205         nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2206         nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2207         assert_eq!(nodes[3].node.list_channels().len(), 0);
2208         assert_eq!(nodes[4].node.list_channels().len(), 0);
2209
2210         nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2211         check_closed_event!(nodes[3], 1);
2212         check_closed_event!(nodes[4], 1);
2213 }
2214
2215 #[test]
2216 fn test_justice_tx() {
2217         // Test justice txn built on revoked HTLC-Success tx, against both sides
2218         let mut alice_config = UserConfig::default();
2219         alice_config.channel_options.announced_channel = true;
2220         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2221         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2222         let mut bob_config = UserConfig::default();
2223         bob_config.channel_options.announced_channel = true;
2224         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2225         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2226         let user_cfgs = [Some(alice_config), Some(bob_config)];
2227         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2228         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2229         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2230         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2231         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2232         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2233         // Create some new channels:
2234         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2235
2236         // A pending HTLC which will be revoked:
2237         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2238         // Get the will-be-revoked local txn from nodes[0]
2239         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2240         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2241         assert_eq!(revoked_local_txn[0].input.len(), 1);
2242         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2243         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2244         assert_eq!(revoked_local_txn[1].input.len(), 1);
2245         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2246         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2247         // Revoke the old state
2248         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2249
2250         {
2251                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2252                 {
2253                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2254                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2255                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2256
2257                         check_spends!(node_txn[0], revoked_local_txn[0]);
2258                         node_txn.swap_remove(0);
2259                         node_txn.truncate(1);
2260                 }
2261                 check_added_monitors!(nodes[1], 1);
2262                 check_closed_event!(nodes[1], 1);
2263                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2264
2265                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2266                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2267                 // Verify broadcast of revoked HTLC-timeout
2268                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2269                 check_added_monitors!(nodes[0], 1);
2270                 check_closed_event!(nodes[0], 1);
2271                 // Broadcast revoked HTLC-timeout on node 1
2272                 mine_transaction(&nodes[1], &node_txn[1]);
2273                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2274         }
2275         get_announce_close_broadcast_events(&nodes, 0, 1);
2276
2277         assert_eq!(nodes[0].node.list_channels().len(), 0);
2278         assert_eq!(nodes[1].node.list_channels().len(), 0);
2279
2280         // We test justice_tx build by A on B's revoked HTLC-Success tx
2281         // Create some new channels:
2282         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2283         {
2284                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2285                 node_txn.clear();
2286         }
2287
2288         // A pending HTLC which will be revoked:
2289         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2290         // Get the will-be-revoked local txn from B
2291         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2292         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2293         assert_eq!(revoked_local_txn[0].input.len(), 1);
2294         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2295         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2296         // Revoke the old state
2297         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2298         {
2299                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2300                 {
2301                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2302                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2303                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2304
2305                         check_spends!(node_txn[0], revoked_local_txn[0]);
2306                         node_txn.swap_remove(0);
2307                 }
2308                 check_added_monitors!(nodes[0], 1);
2309                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2310
2311                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2312                 check_closed_event!(nodes[1], 1);
2313                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2314                 check_added_monitors!(nodes[1], 1);
2315                 mine_transaction(&nodes[0], &node_txn[1]);
2316                 check_closed_event!(nodes[0], 1);
2317                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2318         }
2319         get_announce_close_broadcast_events(&nodes, 0, 1);
2320         assert_eq!(nodes[0].node.list_channels().len(), 0);
2321         assert_eq!(nodes[1].node.list_channels().len(), 0);
2322 }
2323
2324 #[test]
2325 fn revoked_output_claim() {
2326         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2327         // transaction is broadcast by its counterparty
2328         let chanmon_cfgs = create_chanmon_cfgs(2);
2329         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2330         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2331         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2332         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2333         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2334         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2335         assert_eq!(revoked_local_txn.len(), 1);
2336         // Only output is the full channel value back to nodes[0]:
2337         assert_eq!(revoked_local_txn[0].output.len(), 1);
2338         // Send a payment through, updating everyone's latest commitment txn
2339         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2340
2341         // Inform nodes[1] that nodes[0] broadcast a stale tx
2342         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2343         check_added_monitors!(nodes[1], 1);
2344         check_closed_event!(nodes[1], 1);
2345         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2346         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2347
2348         check_spends!(node_txn[0], revoked_local_txn[0]);
2349         check_spends!(node_txn[1], chan_1.3);
2350
2351         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2352         mine_transaction(&nodes[0], &revoked_local_txn[0]);
2353         get_announce_close_broadcast_events(&nodes, 0, 1);
2354         check_added_monitors!(nodes[0], 1);
2355         check_closed_event!(nodes[0], 1);
2356 }
2357
2358 #[test]
2359 fn claim_htlc_outputs_shared_tx() {
2360         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2361         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2362         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2363         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2364         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2365         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2366
2367         // Create some new channel:
2368         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2369
2370         // Rebalance the network to generate htlc in the two directions
2371         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2372         // 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
2373         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2374         let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2375
2376         // Get the will-be-revoked local txn from node[0]
2377         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2378         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2379         assert_eq!(revoked_local_txn[0].input.len(), 1);
2380         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2381         assert_eq!(revoked_local_txn[1].input.len(), 1);
2382         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2383         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2384         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2385
2386         //Revoke the old state
2387         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2388
2389         {
2390                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2391                 check_added_monitors!(nodes[0], 1);
2392                 check_closed_event!(nodes[0], 1);
2393                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2394                 check_added_monitors!(nodes[1], 1);
2395                 check_closed_event!(nodes[1], 1);
2396                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2397                 let events = nodes[1].node.get_and_clear_pending_events();
2398                 expect_payment_failed!(nodes[1], events, payment_hash_2, true);
2399
2400                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2401                 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment
2402
2403                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2404                 check_spends!(node_txn[0], revoked_local_txn[0]);
2405
2406                 let mut witness_lens = BTreeSet::new();
2407                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2408                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2409                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2410                 assert_eq!(witness_lens.len(), 3);
2411                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2412                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2413                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2414
2415                 // Next nodes[1] broadcasts its current local tx state:
2416                 assert_eq!(node_txn[1].input.len(), 1);
2417                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2418         }
2419         get_announce_close_broadcast_events(&nodes, 0, 1);
2420         assert_eq!(nodes[0].node.list_channels().len(), 0);
2421         assert_eq!(nodes[1].node.list_channels().len(), 0);
2422 }
2423
2424 #[test]
2425 fn claim_htlc_outputs_single_tx() {
2426         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2427         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2428         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2429         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2430         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2431         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2432
2433         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2434
2435         // Rebalance the network to generate htlc in the two directions
2436         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2437         // 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
2438         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2439         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2440         let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2441
2442         // Get the will-be-revoked local txn from node[0]
2443         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2444
2445         //Revoke the old state
2446         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2447
2448         {
2449                 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2450                 check_added_monitors!(nodes[0], 1);
2451                 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2452                 check_added_monitors!(nodes[1], 1);
2453                 check_closed_event!(nodes[1], 1);
2454                 let mut events = nodes[0].node.get_and_clear_pending_events();
2455                 expect_pending_htlcs_forwardable_ignore!(nodes[0], events[0..1]);
2456                 match events[1] {
2457                         Event::ChannelClosed { .. } => {}
2458                         _ => panic!("Unexpected event"),
2459                 }
2460
2461                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2462                 let events = nodes[1].node.get_and_clear_pending_events();
2463                 expect_payment_failed!(nodes[1], events, payment_hash_2, true);
2464
2465                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2466                 assert_eq!(node_txn.len(), 9);
2467                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2468                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2469                 // 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)
2470                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2471
2472                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2473                 assert_eq!(node_txn[0].input.len(), 1);
2474                 check_spends!(node_txn[0], chan_1.3);
2475                 assert_eq!(node_txn[1].input.len(), 1);
2476                 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2477                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2478                 check_spends!(node_txn[1], node_txn[0]);
2479
2480                 // Justice transactions are indices 1-2-4
2481                 assert_eq!(node_txn[2].input.len(), 1);
2482                 assert_eq!(node_txn[3].input.len(), 1);
2483                 assert_eq!(node_txn[4].input.len(), 1);
2484
2485                 check_spends!(node_txn[2], revoked_local_txn[0]);
2486                 check_spends!(node_txn[3], revoked_local_txn[0]);
2487                 check_spends!(node_txn[4], revoked_local_txn[0]);
2488
2489                 let mut witness_lens = BTreeSet::new();
2490                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2491                 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2492                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2493                 assert_eq!(witness_lens.len(), 3);
2494                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2495                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2496                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2497         }
2498         get_announce_close_broadcast_events(&nodes, 0, 1);
2499         assert_eq!(nodes[0].node.list_channels().len(), 0);
2500         assert_eq!(nodes[1].node.list_channels().len(), 0);
2501 }
2502
2503 #[test]
2504 fn test_htlc_on_chain_success() {
2505         // Test that in case of a unilateral close onchain, we detect the state of output and pass
2506         // the preimage backward accordingly. So here we test that ChannelManager is
2507         // broadcasting the right event to other nodes in payment path.
2508         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2509         // A --------------------> B ----------------------> C (preimage)
2510         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2511         // commitment transaction was broadcast.
2512         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2513         // towards B.
2514         // B should be able to claim via preimage if A then broadcasts its local tx.
2515         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2516         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2517         // PaymentSent event).
2518
2519         let chanmon_cfgs = create_chanmon_cfgs(3);
2520         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2521         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2522         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2523
2524         // Create some initial channels
2525         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2526         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2527
2528         // Ensure all nodes are at the same height
2529         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2530         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2531         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2532         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2533
2534         // Rebalance the network a bit by relaying one payment through all the channels...
2535         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2536         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2537
2538         let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2539         let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2540
2541         // Broadcast legit commitment tx from C on B's chain
2542         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2543         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2544         assert_eq!(commitment_tx.len(), 1);
2545         check_spends!(commitment_tx[0], chan_2.3);
2546         nodes[2].node.claim_funds(our_payment_preimage);
2547         nodes[2].node.claim_funds(our_payment_preimage_2);
2548         check_added_monitors!(nodes[2], 2);
2549         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2550         assert!(updates.update_add_htlcs.is_empty());
2551         assert!(updates.update_fail_htlcs.is_empty());
2552         assert!(updates.update_fail_malformed_htlcs.is_empty());
2553         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2554
2555         mine_transaction(&nodes[2], &commitment_tx[0]);
2556         check_closed_broadcast!(nodes[2], true);
2557         check_added_monitors!(nodes[2], 1);
2558         check_closed_event!(nodes[2], 1);
2559         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)
2560         assert_eq!(node_txn.len(), 5);
2561         assert_eq!(node_txn[0], node_txn[3]);
2562         assert_eq!(node_txn[1], node_txn[4]);
2563         assert_eq!(node_txn[2], commitment_tx[0]);
2564         check_spends!(node_txn[0], commitment_tx[0]);
2565         check_spends!(node_txn[1], commitment_tx[0]);
2566         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2567         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2568         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2569         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2570         assert_eq!(node_txn[0].lock_time, 0);
2571         assert_eq!(node_txn[1].lock_time, 0);
2572
2573         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2574         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2575         connect_block(&nodes[1], &Block { header, txdata: node_txn});
2576         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2577         {
2578                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2579                 assert_eq!(added_monitors.len(), 1);
2580                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2581                 added_monitors.clear();
2582         }
2583         let forwarded_events = nodes[1].node.get_and_clear_pending_events();
2584         assert_eq!(forwarded_events.len(), 3);
2585         match forwarded_events[0] {
2586                 Event::ChannelClosed { .. } => {}
2587                 _ => panic!("Unexpected event"),
2588         }
2589         if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[1] {
2590                 } else { panic!(); }
2591         if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[2] {
2592                 } else { panic!(); }
2593         let events = nodes[1].node.get_and_clear_pending_msg_events();
2594         {
2595                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2596                 assert_eq!(added_monitors.len(), 2);
2597                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2598                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2599                 added_monitors.clear();
2600         }
2601         assert_eq!(events.len(), 3);
2602         match events[0] {
2603                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2604                 _ => panic!("Unexpected event"),
2605         }
2606         match events[1] {
2607                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2608                 _ => panic!("Unexpected event"),
2609         }
2610
2611         match events[2] {
2612                 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, .. } } => {
2613                         assert!(update_add_htlcs.is_empty());
2614                         assert!(update_fail_htlcs.is_empty());
2615                         assert_eq!(update_fulfill_htlcs.len(), 1);
2616                         assert!(update_fail_malformed_htlcs.is_empty());
2617                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2618                 },
2619                 _ => panic!("Unexpected event"),
2620         };
2621         macro_rules! check_tx_local_broadcast {
2622                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2623                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2624                         assert_eq!(node_txn.len(), 3);
2625                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2626                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2627                         check_spends!(node_txn[1], $commitment_tx);
2628                         check_spends!(node_txn[2], $commitment_tx);
2629                         assert_ne!(node_txn[1].lock_time, 0);
2630                         assert_ne!(node_txn[2].lock_time, 0);
2631                         if $htlc_offered {
2632                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2633                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2634                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2635                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2636                         } else {
2637                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2638                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2639                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2640                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2641                         }
2642                         check_spends!(node_txn[0], $chan_tx);
2643                         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2644                         node_txn.clear();
2645                 } }
2646         }
2647         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2648         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2649         // timeout-claim of the output that nodes[2] just claimed via success.
2650         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2651
2652         // Broadcast legit commitment tx from A on B's chain
2653         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2654         let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2655         check_spends!(node_a_commitment_tx[0], chan_1.3);
2656         mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2657         check_closed_broadcast!(nodes[1], true);
2658         check_added_monitors!(nodes[1], 1);
2659         check_closed_event!(nodes[1], 1);
2660         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2661         assert_eq!(node_txn.len(), 6); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 3 (HTLC-Success, 2* RBF bumps of above HTLC txn)
2662         let commitment_spend =
2663                 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2664                         check_spends!(node_txn[1], commitment_tx[0]);
2665                         check_spends!(node_txn[2], commitment_tx[0]);
2666                         assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2667                         &node_txn[0]
2668                 } else {
2669                         check_spends!(node_txn[0], commitment_tx[0]);
2670                         check_spends!(node_txn[1], commitment_tx[0]);
2671                         assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2672                         &node_txn[2]
2673                 };
2674
2675         check_spends!(commitment_spend, node_a_commitment_tx[0]);
2676         assert_eq!(commitment_spend.input.len(), 2);
2677         assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2678         assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2679         assert_eq!(commitment_spend.lock_time, 0);
2680         assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2681         check_spends!(node_txn[3], chan_1.3);
2682         assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2683         check_spends!(node_txn[4], node_txn[3]);
2684         check_spends!(node_txn[5], node_txn[3]);
2685         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2686         // we already checked the same situation with A.
2687
2688         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2689         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2690         connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
2691         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2692         check_closed_broadcast!(nodes[0], true);
2693         check_added_monitors!(nodes[0], 1);
2694         let events = nodes[0].node.get_and_clear_pending_events();
2695         assert_eq!(events.len(), 3);
2696         let mut first_claimed = false;
2697         for event in events {
2698                 match event {
2699                         Event::PaymentSent { payment_preimage } => {
2700                                 if payment_preimage == our_payment_preimage {
2701                                         assert!(!first_claimed);
2702                                         first_claimed = true;
2703                                 } else {
2704                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2705                                 }
2706                         },
2707                         Event::ChannelClosed { .. } => {},
2708                         _ => panic!("Unexpected event"),
2709                 }
2710         }
2711         check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0], chan_1.3);
2712 }
2713
2714 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2715         // Test that in case of a unilateral close onchain, we detect the state of output and
2716         // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2717         // broadcasting the right event to other nodes in payment path.
2718         // A ------------------> B ----------------------> C (timeout)
2719         //    B's commitment tx                 C's commitment tx
2720         //            \                                  \
2721         //         B's HTLC timeout tx               B's timeout tx
2722
2723         let chanmon_cfgs = create_chanmon_cfgs(3);
2724         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2725         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2726         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2727         *nodes[0].connect_style.borrow_mut() = connect_style;
2728         *nodes[1].connect_style.borrow_mut() = connect_style;
2729         *nodes[2].connect_style.borrow_mut() = connect_style;
2730
2731         // Create some intial channels
2732         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2733         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2734
2735         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2736         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2737         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2738
2739         let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2740
2741         // Broadcast legit commitment tx from C on B's chain
2742         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2743         check_spends!(commitment_tx[0], chan_2.3);
2744         nodes[2].node.fail_htlc_backwards(&payment_hash);
2745         check_added_monitors!(nodes[2], 0);
2746         let events = nodes[2].node.get_and_clear_pending_events();
2747         expect_pending_htlcs_forwardable!(nodes[2], events);
2748         check_added_monitors!(nodes[2], 1);
2749
2750         let events = nodes[2].node.get_and_clear_pending_msg_events();
2751         assert_eq!(events.len(), 1);
2752         match events[0] {
2753                 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, .. } } => {
2754                         assert!(update_add_htlcs.is_empty());
2755                         assert!(!update_fail_htlcs.is_empty());
2756                         assert!(update_fulfill_htlcs.is_empty());
2757                         assert!(update_fail_malformed_htlcs.is_empty());
2758                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2759                 },
2760                 _ => panic!("Unexpected event"),
2761         };
2762         mine_transaction(&nodes[2], &commitment_tx[0]);
2763         check_closed_broadcast!(nodes[2], true);
2764         check_added_monitors!(nodes[2], 1);
2765         check_closed_event!(nodes[2], 1);
2766         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2767         assert_eq!(node_txn.len(), 1);
2768         check_spends!(node_txn[0], chan_2.3);
2769         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2770
2771         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2772         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2773         connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2774         mine_transaction(&nodes[1], &commitment_tx[0]);
2775         check_closed_event!(nodes[1], 1);
2776         let timeout_tx;
2777         {
2778                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2779                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2780                 assert_eq!(node_txn[0], node_txn[3]);
2781                 assert_eq!(node_txn[1], node_txn[4]);
2782
2783                 check_spends!(node_txn[2], commitment_tx[0]);
2784                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2785
2786                 check_spends!(node_txn[0], chan_2.3);
2787                 check_spends!(node_txn[1], node_txn[0]);
2788                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2789                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2790
2791                 timeout_tx = node_txn[2].clone();
2792                 node_txn.clear();
2793         }
2794
2795         mine_transaction(&nodes[1], &timeout_tx);
2796         check_added_monitors!(nodes[1], 1);
2797         check_closed_broadcast!(nodes[1], true);
2798         {
2799                 // B will rebroadcast a fee-bumped timeout transaction here.
2800                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2801                 assert_eq!(node_txn.len(), 1);
2802                 check_spends!(node_txn[0], commitment_tx[0]);
2803         }
2804
2805         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2806         {
2807                 // B may rebroadcast its own holder commitment transaction here, as a safeguard against
2808                 // some incredibly unlikely partial-eclipse-attack scenarios. That said, because the
2809                 // original commitment_tx[0] (also spending chan_2.3) has reached ANTI_REORG_DELAY B really
2810                 // shouldn't broadcast anything here, and in some connect style scenarios we do not.
2811                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2812                 if node_txn.len() == 1 {
2813                         check_spends!(node_txn[0], chan_2.3);
2814                 } else {
2815                         assert_eq!(node_txn.len(), 0);
2816                 }
2817         }
2818
2819         let events = nodes[1].node.get_and_clear_pending_events();
2820         expect_pending_htlcs_forwardable!(nodes[1], events);
2821         check_added_monitors!(nodes[1], 1);
2822         let events = nodes[1].node.get_and_clear_pending_msg_events();
2823         assert_eq!(events.len(), 1);
2824         match events[0] {
2825                 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, .. } } => {
2826                         assert!(update_add_htlcs.is_empty());
2827                         assert!(!update_fail_htlcs.is_empty());
2828                         assert!(update_fulfill_htlcs.is_empty());
2829                         assert!(update_fail_malformed_htlcs.is_empty());
2830                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2831                 },
2832                 _ => panic!("Unexpected event"),
2833         };
2834
2835         // Broadcast legit commitment tx from B on A's chain
2836         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
2837         check_spends!(commitment_tx[0], chan_1.3);
2838
2839         mine_transaction(&nodes[0], &commitment_tx[0]);
2840         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2841
2842         check_closed_broadcast!(nodes[0], true);
2843         check_added_monitors!(nodes[0], 1);
2844         check_closed_event!(nodes[0], 1);
2845         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 commitment tx, ChannelMonitor : 1 timeout tx
2846         assert_eq!(node_txn.len(), 2);
2847         check_spends!(node_txn[0], chan_1.3);
2848         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2849         check_spends!(node_txn[1], commitment_tx[0]);
2850         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2851 }
2852
2853 #[test]
2854 fn test_htlc_on_chain_timeout() {
2855         do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
2856         do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
2857         do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
2858 }
2859
2860 #[test]
2861 fn test_simple_commitment_revoked_fail_backward() {
2862         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2863         // and fail backward accordingly.
2864
2865         let chanmon_cfgs = create_chanmon_cfgs(3);
2866         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2867         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2868         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2869
2870         // Create some initial channels
2871         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2872         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2873
2874         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2875         // Get the will-be-revoked local txn from nodes[2]
2876         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2877         // Revoke the old state
2878         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
2879
2880         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2881
2882         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2883         check_closed_event!(nodes[1], 1);
2884         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2885         check_added_monitors!(nodes[1], 1);
2886         check_closed_broadcast!(nodes[1], true);
2887
2888         let events = nodes[1].node.get_and_clear_pending_events();
2889         expect_pending_htlcs_forwardable!(nodes[1], events);
2890         check_added_monitors!(nodes[1], 1);
2891         let events = nodes[1].node.get_and_clear_pending_msg_events();
2892         assert_eq!(events.len(), 1);
2893         match events[0] {
2894                 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, .. } } => {
2895                         assert!(update_add_htlcs.is_empty());
2896                         assert_eq!(update_fail_htlcs.len(), 1);
2897                         assert!(update_fulfill_htlcs.is_empty());
2898                         assert!(update_fail_malformed_htlcs.is_empty());
2899                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2900
2901                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2902                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2903                         expect_payment_failed_with_update!(nodes[0], payment_hash, false, chan_2.0.contents.short_channel_id, true);
2904                 },
2905                 _ => panic!("Unexpected event"),
2906         }
2907 }
2908
2909 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2910         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2911         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2912         // commitment transaction anymore.
2913         // To do this, we have the peer which will broadcast a revoked commitment transaction send
2914         // a number of update_fail/commitment_signed updates without ever sending the RAA in
2915         // response to our commitment_signed. This is somewhat misbehavior-y, though not
2916         // technically disallowed and we should probably handle it reasonably.
2917         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2918         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2919         // transactions:
2920         // * Once we move it out of our holding cell/add it, we will immediately include it in a
2921         //   commitment_signed (implying it will be in the latest remote commitment transaction).
2922         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2923         //   and once they revoke the previous commitment transaction (allowing us to send a new
2924         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2925         let chanmon_cfgs = create_chanmon_cfgs(3);
2926         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2927         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2928         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2929
2930         // Create some initial channels
2931         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2932         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2933
2934         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 });
2935         // Get the will-be-revoked local txn from nodes[2]
2936         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2937         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2938         // Revoke the old state
2939         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
2940
2941         let value = if use_dust {
2942                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2943                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2944                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
2945         } else { 3000000 };
2946
2947         let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2948         let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2949         let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2950
2951         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
2952         let events = nodes[2].node.get_and_clear_pending_events();
2953         expect_pending_htlcs_forwardable!(nodes[2], events);
2954         check_added_monitors!(nodes[2], 1);
2955         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2956         assert!(updates.update_add_htlcs.is_empty());
2957         assert!(updates.update_fulfill_htlcs.is_empty());
2958         assert!(updates.update_fail_malformed_htlcs.is_empty());
2959         assert_eq!(updates.update_fail_htlcs.len(), 1);
2960         assert!(updates.update_fee.is_none());
2961         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2962         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2963         // Drop the last RAA from 3 -> 2
2964
2965         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
2966         let events = nodes[2].node.get_and_clear_pending_events();
2967         expect_pending_htlcs_forwardable!(nodes[2], events);
2968         check_added_monitors!(nodes[2], 1);
2969         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2970         assert!(updates.update_add_htlcs.is_empty());
2971         assert!(updates.update_fulfill_htlcs.is_empty());
2972         assert!(updates.update_fail_malformed_htlcs.is_empty());
2973         assert_eq!(updates.update_fail_htlcs.len(), 1);
2974         assert!(updates.update_fee.is_none());
2975         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2976         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2977         check_added_monitors!(nodes[1], 1);
2978         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2979         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2980         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2981         check_added_monitors!(nodes[2], 1);
2982
2983         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
2984         let events = nodes[2].node.get_and_clear_pending_events();
2985         expect_pending_htlcs_forwardable!(nodes[2], events);
2986         check_added_monitors!(nodes[2], 1);
2987         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2988         assert!(updates.update_add_htlcs.is_empty());
2989         assert!(updates.update_fulfill_htlcs.is_empty());
2990         assert!(updates.update_fail_malformed_htlcs.is_empty());
2991         assert_eq!(updates.update_fail_htlcs.len(), 1);
2992         assert!(updates.update_fee.is_none());
2993         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2994         // At this point first_payment_hash has dropped out of the latest two commitment
2995         // transactions that nodes[1] is tracking...
2996         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2997         check_added_monitors!(nodes[1], 1);
2998         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2999         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3000         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3001         check_added_monitors!(nodes[2], 1);
3002
3003         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3004         // on nodes[2]'s RAA.
3005         let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3006         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3007         let logger = test_utils::TestLogger::new();
3008         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3009         nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
3010         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3011         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3012         check_added_monitors!(nodes[1], 0);
3013
3014         if deliver_bs_raa {
3015                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3016                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3017                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3018                 check_added_monitors!(nodes[1], 1);
3019                 let events = nodes[1].node.get_and_clear_pending_events();
3020                 assert_eq!(events.len(), 1);
3021                 match events[0] {
3022                         Event::PendingHTLCsForwardable { .. } => { },
3023                         _ => panic!("Unexpected event"),
3024                 };
3025                 // Deliberately don't process the pending fail-back so they all fail back at once after
3026                 // block connection just like the !deliver_bs_raa case
3027         }
3028
3029         let mut failed_htlcs = HashSet::new();
3030         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3031
3032         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3033         check_added_monitors!(nodes[1], 1);
3034         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3035
3036         let events = nodes[1].node.get_and_clear_pending_events();
3037         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3038         match events[0] {
3039                 Event::ChannelClosed { .. } => { },
3040                 _ => panic!("Unexepected event"),
3041         }
3042         match events[1] {
3043                 Event::PaymentFailed { ref payment_hash, .. } => {
3044                         assert_eq!(*payment_hash, fourth_payment_hash);
3045                 },
3046                 _ => panic!("Unexpected event"),
3047         }
3048         if !deliver_bs_raa {
3049                 match events[2] {
3050                         Event::PendingHTLCsForwardable { .. } => { },
3051                         _ => panic!("Unexpected event"),
3052                 };
3053         }
3054         nodes[1].node.process_pending_htlc_forwards();
3055         check_added_monitors!(nodes[1], 1);
3056
3057         let events = nodes[1].node.get_and_clear_pending_msg_events();
3058         assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3059         match events[if deliver_bs_raa { 1 } else { 0 }] {
3060                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3061                 _ => panic!("Unexpected event"),
3062         }
3063         match events[if deliver_bs_raa { 2 } else { 1 }] {
3064                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3065                         assert_eq!(channel_id, chan_2.2);
3066                         assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3067                 },
3068                 _ => panic!("Unexpected event"),
3069         }
3070         if deliver_bs_raa {
3071                 match events[0] {
3072                         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, .. } } => {
3073                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3074                                 assert_eq!(update_add_htlcs.len(), 1);
3075                                 assert!(update_fulfill_htlcs.is_empty());
3076                                 assert!(update_fail_htlcs.is_empty());
3077                                 assert!(update_fail_malformed_htlcs.is_empty());
3078                         },
3079                         _ => panic!("Unexpected event"),
3080                 }
3081         }
3082         match events[if deliver_bs_raa { 3 } else { 2 }] {
3083                 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, .. } } => {
3084                         assert!(update_add_htlcs.is_empty());
3085                         assert_eq!(update_fail_htlcs.len(), 3);
3086                         assert!(update_fulfill_htlcs.is_empty());
3087                         assert!(update_fail_malformed_htlcs.is_empty());
3088                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3089
3090                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3091                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3092                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3093
3094                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3095
3096                         let events = nodes[0].node.get_and_clear_pending_events();
3097                         assert_eq!(events.len(), 3);
3098                         match events[0] {
3099                                 Event::PaymentFailed { ref payment_hash, rejected_by_dest: _, ref network_update, .. } => {
3100                                         assert!(failed_htlcs.insert(payment_hash.0));
3101                                         // If we delivered B's RAA we got an unknown preimage error, not something
3102                                         // that we should update our routing table for.
3103                                         if !deliver_bs_raa {
3104                                                 assert!(network_update.is_some());
3105                                         }
3106                                 },
3107                                 _ => panic!("Unexpected event"),
3108                         }
3109                         match events[1] {
3110                                 Event::PaymentFailed { ref payment_hash, rejected_by_dest: _, ref network_update, .. } => {
3111                                         assert!(failed_htlcs.insert(payment_hash.0));
3112                                         assert!(network_update.is_some());
3113                                 },
3114                                 _ => panic!("Unexpected event"),
3115                         }
3116                         match events[2] {
3117                                 Event::PaymentFailed { ref payment_hash, rejected_by_dest: _, ref network_update, .. } => {
3118                                         assert!(failed_htlcs.insert(payment_hash.0));
3119                                         assert!(network_update.is_some());
3120                                 },
3121                                 _ => panic!("Unexpected event"),
3122                         }
3123                 },
3124                 _ => panic!("Unexpected event"),
3125         }
3126
3127         assert!(failed_htlcs.contains(&first_payment_hash.0));
3128         assert!(failed_htlcs.contains(&second_payment_hash.0));
3129         assert!(failed_htlcs.contains(&third_payment_hash.0));
3130 }
3131
3132 #[test]
3133 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3134         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3135         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3136         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3137         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3138 }
3139
3140 #[test]
3141 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3142         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3143         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3144         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3145         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3146 }
3147
3148 #[test]
3149 fn fail_backward_pending_htlc_upon_channel_failure() {
3150         let chanmon_cfgs = create_chanmon_cfgs(2);
3151         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3152         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3153         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3154         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3155         let logger = test_utils::TestLogger::new();
3156
3157         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3158         {
3159                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3160                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3161                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3162                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3163                 check_added_monitors!(nodes[0], 1);
3164
3165                 let payment_event = {
3166                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3167                         assert_eq!(events.len(), 1);
3168                         SendEvent::from_event(events.remove(0))
3169                 };
3170                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3171                 assert_eq!(payment_event.msgs.len(), 1);
3172         }
3173
3174         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3175         let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3176         {
3177                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3178                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3179                 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3180                 check_added_monitors!(nodes[0], 0);
3181
3182                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3183         }
3184
3185         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3186         {
3187                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3188
3189                 let secp_ctx = Secp256k1::new();
3190                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3191                 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3192                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3193                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3194                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height, &None).unwrap();
3195                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3196                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3197
3198                 // Send a 0-msat update_add_htlc to fail the channel.
3199                 let update_add_htlc = msgs::UpdateAddHTLC {
3200                         channel_id: chan.2,
3201                         htlc_id: 0,
3202                         amount_msat: 0,
3203                         payment_hash,
3204                         cltv_expiry,
3205                         onion_routing_packet,
3206                 };
3207                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3208         }
3209         let events = nodes[0].node.get_and_clear_pending_events();
3210         // Check that Alice fails backward the pending HTLC from the second payment.
3211         expect_payment_failed!(nodes[0], events[0..1].to_vec(), failed_payment_hash, true);
3212         match events[1] {
3213                 Event::ChannelClosed { .. } => {}
3214                 _ => panic!("Unexpected event"),
3215         }
3216         check_closed_broadcast!(nodes[0], true);
3217         check_added_monitors!(nodes[0], 1);
3218 }
3219
3220 #[test]
3221 fn test_htlc_ignore_latest_remote_commitment() {
3222         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3223         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3224         let chanmon_cfgs = create_chanmon_cfgs(2);
3225         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3226         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3227         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3228         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3229
3230         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3231         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3232         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3233         check_closed_broadcast!(nodes[0], true);
3234         check_added_monitors!(nodes[0], 1);
3235         check_closed_event!(nodes[0], 1);
3236
3237         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3238         assert_eq!(node_txn.len(), 3);
3239         assert_eq!(node_txn[0], node_txn[1]);
3240
3241         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3242         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3243         check_closed_broadcast!(nodes[1], true);
3244         check_added_monitors!(nodes[1], 1);
3245         check_closed_event!(nodes[1], 1);
3246
3247         // Duplicate the connect_block call since this may happen due to other listeners
3248         // registering new transactions
3249         header.prev_blockhash = header.block_hash();
3250         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3251 }
3252
3253 #[test]
3254 fn test_force_close_fail_back() {
3255         // Check which HTLCs are failed-backwards on channel force-closure
3256         let chanmon_cfgs = create_chanmon_cfgs(3);
3257         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3258         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3259         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3260         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3261         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3262         let logger = test_utils::TestLogger::new();
3263
3264         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3265
3266         let mut payment_event = {
3267                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3268                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, 42, &logger).unwrap();
3269                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3270                 check_added_monitors!(nodes[0], 1);
3271
3272                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3273                 assert_eq!(events.len(), 1);
3274                 SendEvent::from_event(events.remove(0))
3275         };
3276
3277         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3278         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3279
3280         let events = nodes[1].node.get_and_clear_pending_events();
3281         expect_pending_htlcs_forwardable!(nodes[1], events);
3282
3283         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3284         assert_eq!(events_2.len(), 1);
3285         payment_event = SendEvent::from_event(events_2.remove(0));
3286         assert_eq!(payment_event.msgs.len(), 1);
3287
3288         check_added_monitors!(nodes[1], 1);
3289         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3290         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3291         check_added_monitors!(nodes[2], 1);
3292         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3293
3294         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3295         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3296         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3297
3298         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3299         check_closed_broadcast!(nodes[2], true);
3300         check_added_monitors!(nodes[2], 1);
3301         check_closed_event!(nodes[2], 1);
3302         let tx = {
3303                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3304                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3305                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3306                 // back to nodes[1] upon timeout otherwise.
3307                 assert_eq!(node_txn.len(), 1);
3308                 node_txn.remove(0)
3309         };
3310
3311         mine_transaction(&nodes[1], &tx);
3312
3313         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3314         check_closed_broadcast!(nodes[1], true);
3315         check_added_monitors!(nodes[1], 1);
3316         check_closed_event!(nodes[1], 1);
3317
3318         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3319         {
3320                 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3321                 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3322                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3323         }
3324         mine_transaction(&nodes[2], &tx);
3325         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3326         assert_eq!(node_txn.len(), 1);
3327         assert_eq!(node_txn[0].input.len(), 1);
3328         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3329         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3330         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3331
3332         check_spends!(node_txn[0], tx);
3333 }
3334
3335 #[test]
3336 fn test_dup_events_on_peer_disconnect() {
3337         // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3338         // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3339         // as we used to generate the event immediately upon receipt of the payment preimage in the
3340         // update_fulfill_htlc message.
3341
3342         let chanmon_cfgs = create_chanmon_cfgs(2);
3343         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3344         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3345         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3346         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3347
3348         let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3349
3350         assert!(nodes[1].node.claim_funds(payment_preimage));
3351         check_added_monitors!(nodes[1], 1);
3352         let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3353         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3354         let events = nodes[0].node.get_and_clear_pending_events();
3355         expect_payment_sent!(nodes[0], payment_preimage, events);
3356
3357         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3358         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3359
3360         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3361         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3362 }
3363
3364 #[test]
3365 fn test_simple_peer_disconnect() {
3366         // Test that we can reconnect when there are no lost messages
3367         let chanmon_cfgs = create_chanmon_cfgs(3);
3368         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3369         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3370         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3371         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3372         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3373
3374         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3375         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3376         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3377
3378         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3379         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3380         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3381         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3382
3383         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3384         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3385         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3386
3387         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3388         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3389         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3390         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3391
3392         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3393         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3394
3395         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3396         fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_hash_5);
3397
3398         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3399         {
3400                 let events = nodes[0].node.get_and_clear_pending_events();
3401                 assert_eq!(events.len(), 2);
3402                 match events[0] {
3403                         Event::PaymentSent { payment_preimage } => {
3404                                 assert_eq!(payment_preimage, payment_preimage_3);
3405                         },
3406                         _ => panic!("Unexpected event"),
3407                 }
3408                 match events[1] {
3409                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3410                                 assert_eq!(payment_hash, payment_hash_5);
3411                                 assert!(rejected_by_dest);
3412                         },
3413                         _ => panic!("Unexpected event"),
3414                 }
3415         }
3416
3417         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3418         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3419 }
3420
3421 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken_lnd: bool) {
3422         // Test that we can reconnect when in-flight HTLC updates get dropped
3423         let chanmon_cfgs = create_chanmon_cfgs(2);
3424         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3425         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3426         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3427
3428         let mut as_funding_locked = None;
3429         if messages_delivered == 0 {
3430                 let (funding_locked, _, _) = create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3431                 as_funding_locked = Some(funding_locked);
3432                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3433                 // Note that we store it so that if we're running with `simulate_broken_lnd` we can deliver
3434                 // it before the channel_reestablish message.
3435         } else {
3436                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3437         }
3438
3439         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3440
3441         let logger = test_utils::TestLogger::new();
3442         let payment_event = {
3443                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3444                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph,
3445                         &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3446                         &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3447                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3448                 check_added_monitors!(nodes[0], 1);
3449
3450                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3451                 assert_eq!(events.len(), 1);
3452                 SendEvent::from_event(events.remove(0))
3453         };
3454         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3455
3456         if messages_delivered < 2 {
3457                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3458         } else {
3459                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3460                 if messages_delivered >= 3 {
3461                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3462                         check_added_monitors!(nodes[1], 1);
3463                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3464
3465                         if messages_delivered >= 4 {
3466                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3467                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3468                                 check_added_monitors!(nodes[0], 1);
3469
3470                                 if messages_delivered >= 5 {
3471                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3472                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3473                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3474                                         check_added_monitors!(nodes[0], 1);
3475
3476                                         if messages_delivered >= 6 {
3477                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3478                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3479                                                 check_added_monitors!(nodes[1], 1);
3480                                         }
3481                                 }
3482                         }
3483                 }
3484         }
3485
3486         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3487         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3488         if messages_delivered < 3 {
3489                 if simulate_broken_lnd {
3490                         // lnd has a long-standing bug where they send a funding_locked prior to a
3491                         // channel_reestablish if you reconnect prior to funding_locked time.
3492                         //
3493                         // Here we simulate that behavior, delivering a funding_locked immediately on
3494                         // reconnect. Note that we don't bother skipping the now-duplicate funding_locked sent
3495                         // in `reconnect_nodes` but we currently don't fail based on that.
3496                         //
3497                         // See-also <https://github.com/lightningnetwork/lnd/issues/4006>
3498                         nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding_locked.as_ref().unwrap().0);
3499                 }
3500                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3501                 // received on either side, both sides will need to resend them.
3502                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3503         } else if messages_delivered == 3 {
3504                 // nodes[0] still wants its RAA + commitment_signed
3505                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3506         } else if messages_delivered == 4 {
3507                 // nodes[0] still wants its commitment_signed
3508                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3509         } else if messages_delivered == 5 {
3510                 // nodes[1] still wants its final RAA
3511                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3512         } else if messages_delivered == 6 {
3513                 // Everything was delivered...
3514                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3515         }
3516
3517         let events_1 = nodes[1].node.get_and_clear_pending_events();
3518         assert_eq!(events_1.len(), 1);
3519         match events_1[0] {
3520                 Event::PendingHTLCsForwardable { .. } => { },
3521                 _ => panic!("Unexpected event"),
3522         };
3523
3524         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3525         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3526         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3527
3528         nodes[1].node.process_pending_htlc_forwards();
3529
3530         let events_2 = nodes[1].node.get_and_clear_pending_events();
3531         assert_eq!(events_2.len(), 1);
3532         match events_2[0] {
3533                 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
3534                         assert_eq!(payment_hash_1, *payment_hash);
3535                         assert_eq!(amt, 1000000);
3536                         match &purpose {
3537                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3538                                         assert!(payment_preimage.is_none());
3539                                         assert_eq!(payment_secret_1, *payment_secret);
3540                                 },
3541                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
3542                         }
3543                 },
3544                 _ => panic!("Unexpected event"),
3545         }
3546
3547         nodes[1].node.claim_funds(payment_preimage_1);
3548         check_added_monitors!(nodes[1], 1);
3549
3550         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3551         assert_eq!(events_3.len(), 1);
3552         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3553                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3554                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3555                         assert!(updates.update_add_htlcs.is_empty());
3556                         assert!(updates.update_fail_htlcs.is_empty());
3557                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3558                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3559                         assert!(updates.update_fee.is_none());
3560                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3561                 },
3562                 _ => panic!("Unexpected event"),
3563         };
3564
3565         if messages_delivered >= 1 {
3566                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3567
3568                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3569                 assert_eq!(events_4.len(), 1);
3570                 match events_4[0] {
3571                         Event::PaymentSent { ref payment_preimage } => {
3572                                 assert_eq!(payment_preimage_1, *payment_preimage);
3573                         },
3574                         _ => panic!("Unexpected event"),
3575                 }
3576
3577                 if messages_delivered >= 2 {
3578                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3579                         check_added_monitors!(nodes[0], 1);
3580                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3581
3582                         if messages_delivered >= 3 {
3583                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3584                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3585                                 check_added_monitors!(nodes[1], 1);
3586
3587                                 if messages_delivered >= 4 {
3588                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3589                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3590                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3591                                         check_added_monitors!(nodes[1], 1);
3592
3593                                         if messages_delivered >= 5 {
3594                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3595                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3596                                                 check_added_monitors!(nodes[0], 1);
3597                                         }
3598                                 }
3599                         }
3600                 }
3601         }
3602
3603         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3604         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3605         if messages_delivered < 2 {
3606                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3607                 if messages_delivered < 1 {
3608                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3609                         assert_eq!(events_4.len(), 1);
3610                         match events_4[0] {
3611                                 Event::PaymentSent { ref payment_preimage } => {
3612                                         assert_eq!(payment_preimage_1, *payment_preimage);
3613                                 },
3614                                 _ => panic!("Unexpected event"),
3615                         }
3616                 } else {
3617                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3618                 }
3619         } else if messages_delivered == 2 {
3620                 // nodes[0] still wants its RAA + commitment_signed
3621                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3622         } else if messages_delivered == 3 {
3623                 // nodes[0] still wants its commitment_signed
3624                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3625         } else if messages_delivered == 4 {
3626                 // nodes[1] still wants its final RAA
3627                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3628         } else if messages_delivered == 5 {
3629                 // Everything was delivered...
3630                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3631         }
3632
3633         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3634         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3635         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3636
3637         // Channel should still work fine...
3638         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3639         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph,
3640                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3641                 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3642         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3643         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3644 }
3645
3646 #[test]
3647 fn test_drop_messages_peer_disconnect_a() {
3648         do_test_drop_messages_peer_disconnect(0, true);
3649         do_test_drop_messages_peer_disconnect(0, false);
3650         do_test_drop_messages_peer_disconnect(1, false);
3651         do_test_drop_messages_peer_disconnect(2, false);
3652 }
3653
3654 #[test]
3655 fn test_drop_messages_peer_disconnect_b() {
3656         do_test_drop_messages_peer_disconnect(3, false);
3657         do_test_drop_messages_peer_disconnect(4, false);
3658         do_test_drop_messages_peer_disconnect(5, false);
3659         do_test_drop_messages_peer_disconnect(6, false);
3660 }
3661
3662 #[test]
3663 fn test_funding_peer_disconnect() {
3664         // Test that we can lock in our funding tx while disconnected
3665         let chanmon_cfgs = create_chanmon_cfgs(2);
3666         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3667         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3668         let persister: test_utils::TestPersister;
3669         let new_chain_monitor: test_utils::TestChainMonitor;
3670         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3671         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3672         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3673
3674         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3675         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3676
3677         confirm_transaction(&nodes[0], &tx);
3678         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3679         assert_eq!(events_1.len(), 1);
3680         match events_1[0] {
3681                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3682                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3683                 },
3684                 _ => panic!("Unexpected event"),
3685         }
3686
3687         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3688
3689         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3690         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3691
3692         confirm_transaction(&nodes[1], &tx);
3693         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3694         assert_eq!(events_2.len(), 2);
3695         let funding_locked = match events_2[0] {
3696                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3697                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3698                         msg.clone()
3699                 },
3700                 _ => panic!("Unexpected event"),
3701         };
3702         let bs_announcement_sigs = match events_2[1] {
3703                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3704                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3705                         msg.clone()
3706                 },
3707                 _ => panic!("Unexpected event"),
3708         };
3709
3710         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3711
3712         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3713         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3714         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3715         assert_eq!(events_3.len(), 2);
3716         let as_announcement_sigs = match events_3[0] {
3717                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3718                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3719                         msg.clone()
3720                 },
3721                 _ => panic!("Unexpected event"),
3722         };
3723         let (as_announcement, as_update) = match events_3[1] {
3724                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3725                         (msg.clone(), update_msg.clone())
3726                 },
3727                 _ => panic!("Unexpected event"),
3728         };
3729
3730         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3731         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3732         assert_eq!(events_4.len(), 1);
3733         let (_, bs_update) = match events_4[0] {
3734                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3735                         (msg.clone(), update_msg.clone())
3736                 },
3737                 _ => panic!("Unexpected event"),
3738         };
3739
3740         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3741         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3742         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3743
3744         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3745         let logger = test_utils::TestLogger::new();
3746         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3747         let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3748         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3749
3750         // Check that after deserialization and reconnection we can still generate an identical
3751         // channel_announcement from the cached signatures.
3752         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3753
3754         let nodes_0_serialized = nodes[0].node.encode();
3755         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3756         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3757
3758         persister = test_utils::TestPersister::new();
3759         let keys_manager = &chanmon_cfgs[0].keys_manager;
3760         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);
3761         nodes[0].chain_monitor = &new_chain_monitor;
3762         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3763         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3764                 &mut chan_0_monitor_read, keys_manager).unwrap();
3765         assert!(chan_0_monitor_read.is_empty());
3766
3767         let mut nodes_0_read = &nodes_0_serialized[..];
3768         let (_, nodes_0_deserialized_tmp) = {
3769                 let mut channel_monitors = HashMap::new();
3770                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3771                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3772                         default_config: UserConfig::default(),
3773                         keys_manager,
3774                         fee_estimator: node_cfgs[0].fee_estimator,
3775                         chain_monitor: nodes[0].chain_monitor,
3776                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3777                         logger: nodes[0].logger,
3778                         channel_monitors,
3779                 }).unwrap()
3780         };
3781         nodes_0_deserialized = nodes_0_deserialized_tmp;
3782         assert!(nodes_0_read.is_empty());
3783
3784         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
3785         nodes[0].node = &nodes_0_deserialized;
3786         check_added_monitors!(nodes[0], 1);
3787
3788         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3789
3790         // as_announcement should be re-generated exactly by broadcast_node_announcement.
3791         nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
3792         let msgs = nodes[0].node.get_and_clear_pending_msg_events();
3793         let mut found_announcement = false;
3794         for event in msgs.iter() {
3795                 match event {
3796                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
3797                                 if *msg == as_announcement { found_announcement = true; }
3798                         },
3799                         MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
3800                         _ => panic!("Unexpected event"),
3801                 }
3802         }
3803         assert!(found_announcement);
3804 }
3805
3806 #[test]
3807 fn test_drop_messages_peer_disconnect_dual_htlc() {
3808         // Test that we can handle reconnecting when both sides of a channel have pending
3809         // commitment_updates when we disconnect.
3810         let chanmon_cfgs = create_chanmon_cfgs(2);
3811         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3812         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3813         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3814         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3815         let logger = test_utils::TestLogger::new();
3816
3817         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3818
3819         // Now try to send a second payment which will fail to send
3820         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
3821         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3822         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3823         nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
3824         check_added_monitors!(nodes[0], 1);
3825
3826         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3827         assert_eq!(events_1.len(), 1);
3828         match events_1[0] {
3829                 MessageSendEvent::UpdateHTLCs { .. } => {},
3830                 _ => panic!("Unexpected event"),
3831         }
3832
3833         assert!(nodes[1].node.claim_funds(payment_preimage_1));
3834         check_added_monitors!(nodes[1], 1);
3835
3836         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3837         assert_eq!(events_2.len(), 1);
3838         match events_2[0] {
3839                 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 } } => {
3840                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3841                         assert!(update_add_htlcs.is_empty());
3842                         assert_eq!(update_fulfill_htlcs.len(), 1);
3843                         assert!(update_fail_htlcs.is_empty());
3844                         assert!(update_fail_malformed_htlcs.is_empty());
3845                         assert!(update_fee.is_none());
3846
3847                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3848                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3849                         assert_eq!(events_3.len(), 1);
3850                         match events_3[0] {
3851                                 Event::PaymentSent { ref payment_preimage } => {
3852                                         assert_eq!(*payment_preimage, payment_preimage_1);
3853                                 },
3854                                 _ => panic!("Unexpected event"),
3855                         }
3856
3857                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3858                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3859                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3860                         check_added_monitors!(nodes[0], 1);
3861                 },
3862                 _ => panic!("Unexpected event"),
3863         }
3864
3865         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3866         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3867
3868         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3869         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3870         assert_eq!(reestablish_1.len(), 1);
3871         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3872         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3873         assert_eq!(reestablish_2.len(), 1);
3874
3875         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3876         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3877         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3878         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3879
3880         assert!(as_resp.0.is_none());
3881         assert!(bs_resp.0.is_none());
3882
3883         assert!(bs_resp.1.is_none());
3884         assert!(bs_resp.2.is_none());
3885
3886         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3887
3888         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3889         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3890         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3891         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3892         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3893         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3894         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3895         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3896         // No commitment_signed so get_event_msg's assert(len == 1) passes
3897         check_added_monitors!(nodes[1], 1);
3898
3899         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3900         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3901         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3902         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3903         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3904         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3905         assert!(bs_second_commitment_signed.update_fee.is_none());
3906         check_added_monitors!(nodes[1], 1);
3907
3908         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3909         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3910         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3911         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3912         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3913         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3914         assert!(as_commitment_signed.update_fee.is_none());
3915         check_added_monitors!(nodes[0], 1);
3916
3917         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3918         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3919         // No commitment_signed so get_event_msg's assert(len == 1) passes
3920         check_added_monitors!(nodes[0], 1);
3921
3922         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3923         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3924         // No commitment_signed so get_event_msg's assert(len == 1) passes
3925         check_added_monitors!(nodes[1], 1);
3926
3927         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3928         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3929         check_added_monitors!(nodes[1], 1);
3930
3931         let events = nodes[1].node.get_and_clear_pending_events();
3932         expect_pending_htlcs_forwardable!(nodes[1], events);
3933
3934         let events_5 = nodes[1].node.get_and_clear_pending_events();
3935         assert_eq!(events_5.len(), 1);
3936         match events_5[0] {
3937                 Event::PaymentReceived { ref payment_hash, ref purpose, .. } => {
3938                         assert_eq!(payment_hash_2, *payment_hash);
3939                         match &purpose {
3940                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3941                                         assert!(payment_preimage.is_none());
3942                                         assert_eq!(payment_secret_2, *payment_secret);
3943                                 },
3944                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
3945                         }
3946                 },
3947                 _ => panic!("Unexpected event"),
3948         }
3949
3950         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3951         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3952         check_added_monitors!(nodes[0], 1);
3953
3954         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3955 }
3956
3957 fn do_test_htlc_timeout(send_partial_mpp: bool) {
3958         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
3959         // to avoid our counterparty failing the channel.
3960         let chanmon_cfgs = create_chanmon_cfgs(2);
3961         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3962         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3963         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3964
3965         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3966         let logger = test_utils::TestLogger::new();
3967
3968         let our_payment_hash = if send_partial_mpp {
3969                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3970                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
3971                 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
3972                 // Use the utility function send_payment_along_path to send the payment with MPP data which
3973                 // indicates there are more HTLCs coming.
3974                 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.
3975                 let mpp_id = MppId([42; 32]);
3976                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height, mpp_id, &None).unwrap();
3977                 check_added_monitors!(nodes[0], 1);
3978                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3979                 assert_eq!(events.len(), 1);
3980                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
3981                 // hop should *not* yet generate any PaymentReceived event(s).
3982                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
3983                 our_payment_hash
3984         } else {
3985                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
3986         };
3987
3988         let mut block = Block {
3989                 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
3990                 txdata: vec![],
3991         };
3992         connect_block(&nodes[0], &block);
3993         connect_block(&nodes[1], &block);
3994         let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
3995         for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
3996                 block.header.prev_blockhash = block.block_hash();
3997                 connect_block(&nodes[0], &block);
3998                 connect_block(&nodes[1], &block);
3999         }
4000
4001         let events = nodes[1].node.get_and_clear_pending_events();
4002         expect_pending_htlcs_forwardable!(nodes[1], events);
4003
4004         check_added_monitors!(nodes[1], 1);
4005         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4006         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4007         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4008         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4009         assert!(htlc_timeout_updates.update_fee.is_none());
4010
4011         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4012         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4013         // 100_000 msat as u64, followed by the height at which we failed back above
4014         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4015         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4016         let events = nodes[0].node.get_and_clear_pending_events();
4017         expect_payment_failed!(nodes[0], events, our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4018 }
4019
4020 #[test]
4021 fn test_htlc_timeout() {
4022         do_test_htlc_timeout(true);
4023         do_test_htlc_timeout(false);
4024 }
4025
4026 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4027         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4028         let chanmon_cfgs = create_chanmon_cfgs(3);
4029         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4030         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4031         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4032         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4033         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4034
4035         // Make sure all nodes are at the same starting height
4036         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4037         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4038         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4039
4040         let logger = test_utils::TestLogger::new();
4041
4042         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4043         let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4044         {
4045                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4046                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4047                 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4048         }
4049         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4050         check_added_monitors!(nodes[1], 1);
4051
4052         // Now attempt to route a second payment, which should be placed in the holding cell
4053         let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4054         if forwarded_htlc {
4055                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4056                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4057                 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4058                 check_added_monitors!(nodes[0], 1);
4059                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4060                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4061                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4062                 let events = nodes[1].node.get_and_clear_pending_events();
4063                 expect_pending_htlcs_forwardable!(nodes[1], events);
4064                 check_added_monitors!(nodes[1], 0);
4065         } else {
4066                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4067                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4068                 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4069                 check_added_monitors!(nodes[1], 0);
4070         }
4071
4072         connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4073         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4074         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4075         connect_blocks(&nodes[1], 1);
4076
4077         if forwarded_htlc {
4078                 let events = nodes[1].node.get_and_clear_pending_events();
4079                 expect_pending_htlcs_forwardable!(nodes[1], events);
4080                 check_added_monitors!(nodes[1], 1);
4081                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4082                 assert_eq!(fail_commit.len(), 1);
4083                 match fail_commit[0] {
4084                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4085                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4086                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4087                         },
4088                         _ => unreachable!(),
4089                 }
4090                 expect_payment_failed_with_update!(nodes[0], second_payment_hash, false, chan_2.0.contents.short_channel_id, false);
4091         } else {
4092                 let events = nodes[1].node.get_and_clear_pending_events();
4093                 expect_payment_failed!(nodes[1], events, second_payment_hash, true);
4094         }
4095 }
4096
4097 #[test]
4098 fn test_holding_cell_htlc_add_timeouts() {
4099         do_test_holding_cell_htlc_add_timeouts(false);
4100         do_test_holding_cell_htlc_add_timeouts(true);
4101 }
4102
4103 #[test]
4104 fn test_no_txn_manager_serialize_deserialize() {
4105         let chanmon_cfgs = create_chanmon_cfgs(2);
4106         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4107         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4108         let logger: test_utils::TestLogger;
4109         let fee_estimator: test_utils::TestFeeEstimator;
4110         let persister: test_utils::TestPersister;
4111         let new_chain_monitor: test_utils::TestChainMonitor;
4112         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4113         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4114
4115         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4116
4117         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4118
4119         let nodes_0_serialized = nodes[0].node.encode();
4120         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4121         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4122
4123         logger = test_utils::TestLogger::new();
4124         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4125         persister = test_utils::TestPersister::new();
4126         let keys_manager = &chanmon_cfgs[0].keys_manager;
4127         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4128         nodes[0].chain_monitor = &new_chain_monitor;
4129         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4130         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4131                 &mut chan_0_monitor_read, keys_manager).unwrap();
4132         assert!(chan_0_monitor_read.is_empty());
4133
4134         let mut nodes_0_read = &nodes_0_serialized[..];
4135         let config = UserConfig::default();
4136         let (_, nodes_0_deserialized_tmp) = {
4137                 let mut channel_monitors = HashMap::new();
4138                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4139                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4140                         default_config: config,
4141                         keys_manager,
4142                         fee_estimator: &fee_estimator,
4143                         chain_monitor: nodes[0].chain_monitor,
4144                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4145                         logger: &logger,
4146                         channel_monitors,
4147                 }).unwrap()
4148         };
4149         nodes_0_deserialized = nodes_0_deserialized_tmp;
4150         assert!(nodes_0_read.is_empty());
4151
4152         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4153         nodes[0].node = &nodes_0_deserialized;
4154         assert_eq!(nodes[0].node.list_channels().len(), 1);
4155         check_added_monitors!(nodes[0], 1);
4156
4157         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4158         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4159         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4160         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4161
4162         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4163         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4164         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4165         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4166
4167         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4168         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4169         for node in nodes.iter() {
4170                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4171                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4172                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4173         }
4174
4175         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4176 }
4177
4178 #[test]
4179 fn mpp_failure() {
4180         let chanmon_cfgs = create_chanmon_cfgs(4);
4181         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4182         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4183         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4184
4185         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4186         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4187         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4188         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4189         let logger = test_utils::TestLogger::new();
4190
4191         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
4192         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4193         let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
4194         let path = route.paths[0].clone();
4195         route.paths.push(path);
4196         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
4197         route.paths[0][0].short_channel_id = chan_1_id;
4198         route.paths[0][1].short_channel_id = chan_3_id;
4199         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
4200         route.paths[1][0].short_channel_id = chan_2_id;
4201         route.paths[1][1].short_channel_id = chan_4_id;
4202         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
4203         fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash);
4204 }
4205
4206 #[test]
4207 fn test_dup_htlc_onchain_fails_on_reload() {
4208         // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4209         // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4210         // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4211         // the ChannelMonitor tells it to.
4212         //
4213         // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4214         // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4215         // PaymentFailed event appearing). However, because we may not serialize the relevant
4216         // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4217         // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4218         // and de-duplicates ChannelMonitor events.
4219         //
4220         // This tests that explicit tracking behavior.
4221         let chanmon_cfgs = create_chanmon_cfgs(2);
4222         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4223         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4224         let persister: test_utils::TestPersister;
4225         let new_chain_monitor: test_utils::TestChainMonitor;
4226         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4227         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4228
4229         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4230
4231         // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4232         // nodes[0].
4233         let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4234         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4235         check_closed_broadcast!(nodes[0], true);
4236         check_added_monitors!(nodes[0], 1);
4237         check_closed_event!(nodes[0], 1);
4238
4239         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4240         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4241
4242         // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
4243         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
4244         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4245         assert_eq!(node_txn.len(), 3);
4246         assert_eq!(node_txn[0], node_txn[1]);
4247
4248         assert!(nodes[1].node.claim_funds(payment_preimage));
4249         check_added_monitors!(nodes[1], 1);
4250
4251         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4252         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4253         check_closed_broadcast!(nodes[1], true);
4254         check_added_monitors!(nodes[1], 1);
4255         check_closed_event!(nodes[1], 1);
4256         let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4257
4258         header.prev_blockhash = nodes[0].best_block_hash();
4259         connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4260
4261         // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4262         // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4263         // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4264         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4265         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4266
4267         header.prev_blockhash = nodes[0].best_block_hash();
4268         let claim_block = Block { header, txdata: claim_txn};
4269         connect_block(&nodes[0], &claim_block);
4270         let events = nodes[0].node.get_and_clear_pending_events();
4271         expect_payment_sent!(nodes[0], payment_preimage, events);
4272
4273         // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4274         // connected a highly-relevant block, it likely gets serialized out now.
4275         let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4276         nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4277
4278         // Now reload nodes[0]...
4279         persister = test_utils::TestPersister::new();
4280         let keys_manager = &chanmon_cfgs[0].keys_manager;
4281         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);
4282         nodes[0].chain_monitor = &new_chain_monitor;
4283         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4284         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4285                 &mut chan_0_monitor_read, keys_manager).unwrap();
4286         assert!(chan_0_monitor_read.is_empty());
4287
4288         let (_, nodes_0_deserialized_tmp) = {
4289                 let mut channel_monitors = HashMap::new();
4290                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4291                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4292                         ::read(&mut io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4293                                 default_config: Default::default(),
4294                                 keys_manager,
4295                                 fee_estimator: node_cfgs[0].fee_estimator,
4296                                 chain_monitor: nodes[0].chain_monitor,
4297                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4298                                 logger: nodes[0].logger,
4299                                 channel_monitors,
4300                         }).unwrap()
4301         };
4302         nodes_0_deserialized = nodes_0_deserialized_tmp;
4303
4304         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4305         check_added_monitors!(nodes[0], 1);
4306         nodes[0].node = &nodes_0_deserialized;
4307
4308         // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4309         // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4310         // payment events should kick in, leaving us with no pending events here.
4311         let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
4312         nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
4313         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4314 }
4315
4316 #[test]
4317 fn test_manager_serialize_deserialize_events() {
4318         // This test makes sure the events field in ChannelManager survives de/serialization
4319         let chanmon_cfgs = create_chanmon_cfgs(2);
4320         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4321         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4322         let fee_estimator: test_utils::TestFeeEstimator;
4323         let persister: test_utils::TestPersister;
4324         let logger: test_utils::TestLogger;
4325         let new_chain_monitor: test_utils::TestChainMonitor;
4326         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4327         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4328
4329         // Start creating a channel, but stop right before broadcasting the funding transaction
4330         let channel_value = 100000;
4331         let push_msat = 10001;
4332         let a_flags = InitFeatures::known();
4333         let b_flags = InitFeatures::known();
4334         let node_a = nodes.remove(0);
4335         let node_b = nodes.remove(0);
4336         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4337         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()));
4338         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()));
4339
4340         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4341
4342         node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4343         check_added_monitors!(node_a, 0);
4344
4345         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()));
4346         {
4347                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4348                 assert_eq!(added_monitors.len(), 1);
4349                 assert_eq!(added_monitors[0].0, funding_output);
4350                 added_monitors.clear();
4351         }
4352
4353         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()));
4354         {
4355                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4356                 assert_eq!(added_monitors.len(), 1);
4357                 assert_eq!(added_monitors[0].0, funding_output);
4358                 added_monitors.clear();
4359         }
4360         // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4361
4362         nodes.push(node_a);
4363         nodes.push(node_b);
4364
4365         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4366         let nodes_0_serialized = nodes[0].node.encode();
4367         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4368         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4369
4370         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4371         logger = test_utils::TestLogger::new();
4372         persister = test_utils::TestPersister::new();
4373         let keys_manager = &chanmon_cfgs[0].keys_manager;
4374         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4375         nodes[0].chain_monitor = &new_chain_monitor;
4376         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4377         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4378                 &mut chan_0_monitor_read, keys_manager).unwrap();
4379         assert!(chan_0_monitor_read.is_empty());
4380
4381         let mut nodes_0_read = &nodes_0_serialized[..];
4382         let config = UserConfig::default();
4383         let (_, nodes_0_deserialized_tmp) = {
4384                 let mut channel_monitors = HashMap::new();
4385                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4386                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4387                         default_config: config,
4388                         keys_manager,
4389                         fee_estimator: &fee_estimator,
4390                         chain_monitor: nodes[0].chain_monitor,
4391                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4392                         logger: &logger,
4393                         channel_monitors,
4394                 }).unwrap()
4395         };
4396         nodes_0_deserialized = nodes_0_deserialized_tmp;
4397         assert!(nodes_0_read.is_empty());
4398
4399         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4400
4401         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4402         nodes[0].node = &nodes_0_deserialized;
4403
4404         // After deserializing, make sure the funding_transaction is still held by the channel manager
4405         let events_4 = nodes[0].node.get_and_clear_pending_events();
4406         assert_eq!(events_4.len(), 0);
4407         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4408         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4409
4410         // Make sure the channel is functioning as though the de/serialization never happened
4411         assert_eq!(nodes[0].node.list_channels().len(), 1);
4412         check_added_monitors!(nodes[0], 1);
4413
4414         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4415         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4416         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4417         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4418
4419         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4420         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4421         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4422         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4423
4424         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4425         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4426         for node in nodes.iter() {
4427                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4428                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4429                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4430         }
4431
4432         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4433 }
4434
4435 #[test]
4436 fn test_simple_manager_serialize_deserialize() {
4437         let chanmon_cfgs = create_chanmon_cfgs(2);
4438         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4439         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4440         let logger: test_utils::TestLogger;
4441         let fee_estimator: test_utils::TestFeeEstimator;
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         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4447
4448         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4449         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4450
4451         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4452
4453         let nodes_0_serialized = nodes[0].node.encode();
4454         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4455         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4456
4457         logger = test_utils::TestLogger::new();
4458         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4459         persister = test_utils::TestPersister::new();
4460         let keys_manager = &chanmon_cfgs[0].keys_manager;
4461         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4462         nodes[0].chain_monitor = &new_chain_monitor;
4463         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4464         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4465                 &mut chan_0_monitor_read, keys_manager).unwrap();
4466         assert!(chan_0_monitor_read.is_empty());
4467
4468         let mut nodes_0_read = &nodes_0_serialized[..];
4469         let (_, nodes_0_deserialized_tmp) = {
4470                 let mut channel_monitors = HashMap::new();
4471                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4472                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4473                         default_config: UserConfig::default(),
4474                         keys_manager,
4475                         fee_estimator: &fee_estimator,
4476                         chain_monitor: nodes[0].chain_monitor,
4477                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4478                         logger: &logger,
4479                         channel_monitors,
4480                 }).unwrap()
4481         };
4482         nodes_0_deserialized = nodes_0_deserialized_tmp;
4483         assert!(nodes_0_read.is_empty());
4484
4485         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4486         nodes[0].node = &nodes_0_deserialized;
4487         check_added_monitors!(nodes[0], 1);
4488
4489         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4490
4491         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4492         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4493 }
4494
4495 #[test]
4496 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4497         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4498         let chanmon_cfgs = create_chanmon_cfgs(4);
4499         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4500         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4501         let logger: test_utils::TestLogger;
4502         let fee_estimator: test_utils::TestFeeEstimator;
4503         let persister: test_utils::TestPersister;
4504         let new_chain_monitor: test_utils::TestChainMonitor;
4505         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4506         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4507         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4508         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4509         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4510
4511         let mut node_0_stale_monitors_serialized = Vec::new();
4512         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4513                 let mut writer = test_utils::TestVecWriter(Vec::new());
4514                 monitor.1.write(&mut writer).unwrap();
4515                 node_0_stale_monitors_serialized.push(writer.0);
4516         }
4517
4518         let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4519
4520         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4521         let nodes_0_serialized = nodes[0].node.encode();
4522
4523         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4524         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4525         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4526         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4527
4528         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4529         // nodes[3])
4530         let mut node_0_monitors_serialized = Vec::new();
4531         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4532                 let mut writer = test_utils::TestVecWriter(Vec::new());
4533                 monitor.1.write(&mut writer).unwrap();
4534                 node_0_monitors_serialized.push(writer.0);
4535         }
4536
4537         logger = test_utils::TestLogger::new();
4538         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4539         persister = test_utils::TestPersister::new();
4540         let keys_manager = &chanmon_cfgs[0].keys_manager;
4541         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4542         nodes[0].chain_monitor = &new_chain_monitor;
4543
4544
4545         let mut node_0_stale_monitors = Vec::new();
4546         for serialized in node_0_stale_monitors_serialized.iter() {
4547                 let mut read = &serialized[..];
4548                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4549                 assert!(read.is_empty());
4550                 node_0_stale_monitors.push(monitor);
4551         }
4552
4553         let mut node_0_monitors = Vec::new();
4554         for serialized in node_0_monitors_serialized.iter() {
4555                 let mut read = &serialized[..];
4556                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4557                 assert!(read.is_empty());
4558                 node_0_monitors.push(monitor);
4559         }
4560
4561         let mut nodes_0_read = &nodes_0_serialized[..];
4562         if let Err(msgs::DecodeError::InvalidValue) =
4563                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4564                 default_config: UserConfig::default(),
4565                 keys_manager,
4566                 fee_estimator: &fee_estimator,
4567                 chain_monitor: nodes[0].chain_monitor,
4568                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4569                 logger: &logger,
4570                 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4571         }) { } else {
4572                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4573         };
4574
4575         let mut nodes_0_read = &nodes_0_serialized[..];
4576         let (_, nodes_0_deserialized_tmp) =
4577                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4578                 default_config: UserConfig::default(),
4579                 keys_manager,
4580                 fee_estimator: &fee_estimator,
4581                 chain_monitor: nodes[0].chain_monitor,
4582                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4583                 logger: &logger,
4584                 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4585         }).unwrap();
4586         nodes_0_deserialized = nodes_0_deserialized_tmp;
4587         assert!(nodes_0_read.is_empty());
4588
4589         { // Channel close should result in a commitment tx
4590                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4591                 assert_eq!(txn.len(), 1);
4592                 check_spends!(txn[0], funding_tx);
4593                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4594         }
4595
4596         for monitor in node_0_monitors.drain(..) {
4597                 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4598                 check_added_monitors!(nodes[0], 1);
4599         }
4600         nodes[0].node = &nodes_0_deserialized;
4601
4602         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4603         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4604         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4605         //... and we can even still claim the payment!
4606         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4607
4608         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4609         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4610         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4611         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4612         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4613         assert_eq!(msg_events.len(), 1);
4614         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4615                 match action {
4616                         &ErrorAction::SendErrorMessage { ref msg } => {
4617                                 assert_eq!(msg.channel_id, channel_id);
4618                         },
4619                         _ => panic!("Unexpected event!"),
4620                 }
4621         }
4622 }
4623
4624 macro_rules! check_spendable_outputs {
4625         ($node: expr, $keysinterface: expr) => {
4626                 {
4627                         let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4628                         let mut txn = Vec::new();
4629                         let mut all_outputs = Vec::new();
4630                         let secp_ctx = Secp256k1::new();
4631                         for event in events.drain(..) {
4632                                 match event {
4633                                         Event::SpendableOutputs { mut outputs } => {
4634                                                 for outp in outputs.drain(..) {
4635                                                         txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4636                                                         all_outputs.push(outp);
4637                                                 }
4638                                         },
4639                                         _ => panic!("Unexpected event"),
4640                                 };
4641                         }
4642                         if all_outputs.len() > 1 {
4643                                 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) {
4644                                         txn.push(tx);
4645                                 }
4646                         }
4647                         txn
4648                 }
4649         }
4650 }
4651
4652 #[test]
4653 fn test_claim_sizeable_push_msat() {
4654         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4655         let chanmon_cfgs = create_chanmon_cfgs(2);
4656         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4657         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4658         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4659
4660         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4661         nodes[1].node.force_close_channel(&chan.2).unwrap();
4662         check_closed_broadcast!(nodes[1], true);
4663         check_added_monitors!(nodes[1], 1);
4664         check_closed_event!(nodes[1], 1);
4665         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4666         assert_eq!(node_txn.len(), 1);
4667         check_spends!(node_txn[0], chan.3);
4668         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
4669
4670         mine_transaction(&nodes[1], &node_txn[0]);
4671         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4672
4673         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4674         assert_eq!(spend_txn.len(), 1);
4675         assert_eq!(spend_txn[0].input.len(), 1);
4676         check_spends!(spend_txn[0], node_txn[0]);
4677         assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
4678 }
4679
4680 #[test]
4681 fn test_claim_on_remote_sizeable_push_msat() {
4682         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4683         // to_remote output is encumbered by a P2WPKH
4684         let chanmon_cfgs = create_chanmon_cfgs(2);
4685         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4686         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4687         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4688
4689         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4690         nodes[0].node.force_close_channel(&chan.2).unwrap();
4691         check_closed_broadcast!(nodes[0], true);
4692         check_added_monitors!(nodes[0], 1);
4693         check_closed_event!(nodes[0], 1);
4694
4695         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4696         assert_eq!(node_txn.len(), 1);
4697         check_spends!(node_txn[0], chan.3);
4698         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
4699
4700         mine_transaction(&nodes[1], &node_txn[0]);
4701         check_closed_broadcast!(nodes[1], true);
4702         check_added_monitors!(nodes[1], 1);
4703         check_closed_event!(nodes[1], 1);
4704         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4705
4706         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4707         assert_eq!(spend_txn.len(), 1);
4708         check_spends!(spend_txn[0], node_txn[0]);
4709 }
4710
4711 #[test]
4712 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4713         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4714         // to_remote output is encumbered by a P2WPKH
4715
4716         let chanmon_cfgs = create_chanmon_cfgs(2);
4717         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4718         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4719         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4720
4721         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4722         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4723         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4724         assert_eq!(revoked_local_txn[0].input.len(), 1);
4725         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4726
4727         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4728         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4729         check_closed_broadcast!(nodes[1], true);
4730         check_added_monitors!(nodes[1], 1);
4731         check_closed_event!(nodes[1], 1);
4732
4733         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4734         mine_transaction(&nodes[1], &node_txn[0]);
4735         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4736
4737         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4738         assert_eq!(spend_txn.len(), 3);
4739         check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4740         check_spends!(spend_txn[1], node_txn[0]);
4741         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4742 }
4743
4744 #[test]
4745 fn test_static_spendable_outputs_preimage_tx() {
4746         let chanmon_cfgs = create_chanmon_cfgs(2);
4747         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4748         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4749         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4750
4751         // Create some initial channels
4752         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4753
4754         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4755
4756         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4757         assert_eq!(commitment_tx[0].input.len(), 1);
4758         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4759
4760         // Settle A's commitment tx on B's chain
4761         assert!(nodes[1].node.claim_funds(payment_preimage));
4762         check_added_monitors!(nodes[1], 1);
4763         mine_transaction(&nodes[1], &commitment_tx[0]);
4764         check_added_monitors!(nodes[1], 1);
4765         let events = nodes[1].node.get_and_clear_pending_msg_events();
4766         match events[0] {
4767                 MessageSendEvent::UpdateHTLCs { .. } => {},
4768                 _ => panic!("Unexpected event"),
4769         }
4770         match events[1] {
4771                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4772                 _ => panic!("Unexepected event"),
4773         }
4774
4775         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4776         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4777         assert_eq!(node_txn.len(), 3);
4778         check_spends!(node_txn[0], commitment_tx[0]);
4779         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4780         check_spends!(node_txn[1], chan_1.3);
4781         check_spends!(node_txn[2], node_txn[1]);
4782
4783         mine_transaction(&nodes[1], &node_txn[0]);
4784         check_closed_event!(nodes[1], 1);
4785         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4786
4787         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4788         assert_eq!(spend_txn.len(), 1);
4789         check_spends!(spend_txn[0], node_txn[0]);
4790 }
4791
4792 #[test]
4793 fn test_static_spendable_outputs_timeout_tx() {
4794         let chanmon_cfgs = create_chanmon_cfgs(2);
4795         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4796         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4797         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4798
4799         // Create some initial channels
4800         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4801
4802         // Rebalance the network a bit by relaying one payment through all the channels ...
4803         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4804
4805         let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4806
4807         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4808         assert_eq!(commitment_tx[0].input.len(), 1);
4809         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4810
4811         // Settle A's commitment tx on B' chain
4812         mine_transaction(&nodes[1], &commitment_tx[0]);
4813         check_added_monitors!(nodes[1], 1);
4814         let events = nodes[1].node.get_and_clear_pending_msg_events();
4815         match events[0] {
4816                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4817                 _ => panic!("Unexpected event"),
4818         }
4819         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
4820
4821         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4822         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4823         assert_eq!(node_txn.len(), 2); // ChannelManager : 1 local commitent tx, ChannelMonitor: timeout tx
4824         check_spends!(node_txn[0], chan_1.3.clone());
4825         check_spends!(node_txn[1],  commitment_tx[0].clone());
4826         assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4827
4828         mine_transaction(&nodes[1], &node_txn[1]);
4829         check_closed_event!(nodes[1], 1);
4830         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4831         let events = nodes[1].node.get_and_clear_pending_events();
4832         expect_payment_failed!(nodes[1], events, our_payment_hash, true);
4833
4834         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4835         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
4836         check_spends!(spend_txn[0], commitment_tx[0]);
4837         check_spends!(spend_txn[1], node_txn[1]);
4838         check_spends!(spend_txn[2], node_txn[1], commitment_tx[0]); // All outputs
4839 }
4840
4841 #[test]
4842 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4843         let chanmon_cfgs = create_chanmon_cfgs(2);
4844         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4845         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4846         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4847
4848         // Create some initial channels
4849         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4850
4851         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4852         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4853         assert_eq!(revoked_local_txn[0].input.len(), 1);
4854         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4855
4856         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4857
4858         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4859         check_closed_broadcast!(nodes[1], true);
4860         check_added_monitors!(nodes[1], 1);
4861         check_closed_event!(nodes[1], 1);
4862
4863         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4864         assert_eq!(node_txn.len(), 2);
4865         assert_eq!(node_txn[0].input.len(), 2);
4866         check_spends!(node_txn[0], revoked_local_txn[0]);
4867
4868         mine_transaction(&nodes[1], &node_txn[0]);
4869         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4870
4871         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4872         assert_eq!(spend_txn.len(), 1);
4873         check_spends!(spend_txn[0], node_txn[0]);
4874 }
4875
4876 #[test]
4877 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4878         let mut chanmon_cfgs = create_chanmon_cfgs(2);
4879         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
4880         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4881         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4882         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4883
4884         // Create some initial channels
4885         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4886
4887         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4888         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4889         assert_eq!(revoked_local_txn[0].input.len(), 1);
4890         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4891
4892         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4893
4894         // A will generate HTLC-Timeout from revoked commitment tx
4895         mine_transaction(&nodes[0], &revoked_local_txn[0]);
4896         check_closed_broadcast!(nodes[0], true);
4897         check_added_monitors!(nodes[0], 1);
4898         check_closed_event!(nodes[0], 1);
4899         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
4900
4901         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4902         assert_eq!(revoked_htlc_txn.len(), 2);
4903         check_spends!(revoked_htlc_txn[0], chan_1.3);
4904         assert_eq!(revoked_htlc_txn[1].input.len(), 1);
4905         assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4906         check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
4907         assert_ne!(revoked_htlc_txn[1].lock_time, 0); // HTLC-Timeout
4908
4909         // B will generate justice tx from A's revoked commitment/HTLC tx
4910         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4911         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
4912         check_closed_broadcast!(nodes[1], true);
4913         check_added_monitors!(nodes[1], 1);
4914         check_closed_event!(nodes[1], 1);
4915
4916         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4917         assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
4918         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4919         // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
4920         // transactions next...
4921         assert_eq!(node_txn[0].input.len(), 3);
4922         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
4923
4924         assert_eq!(node_txn[1].input.len(), 2);
4925         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
4926         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
4927                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
4928         } else {
4929                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
4930                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
4931         }
4932
4933         assert_eq!(node_txn[2].input.len(), 1);
4934         check_spends!(node_txn[2], chan_1.3);
4935
4936         mine_transaction(&nodes[1], &node_txn[1]);
4937         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4938
4939         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4940         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4941         assert_eq!(spend_txn.len(), 1);
4942         assert_eq!(spend_txn[0].input.len(), 1);
4943         check_spends!(spend_txn[0], node_txn[1]);
4944 }
4945
4946 #[test]
4947 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4948         let mut chanmon_cfgs = create_chanmon_cfgs(2);
4949         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
4950         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4951         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4952         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4953
4954         // Create some initial channels
4955         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4956
4957         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4958         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4959         assert_eq!(revoked_local_txn[0].input.len(), 1);
4960         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4961
4962         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
4963         assert_eq!(revoked_local_txn[0].output.len(), 2);
4964
4965         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4966
4967         // B will generate HTLC-Success from revoked commitment tx
4968         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4969         check_closed_broadcast!(nodes[1], true);
4970         check_added_monitors!(nodes[1], 1);
4971         check_closed_event!(nodes[1], 1);
4972         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4973
4974         assert_eq!(revoked_htlc_txn.len(), 2);
4975         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4976         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4977         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4978
4979         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
4980         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
4981         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
4982
4983         // A will generate justice tx from B's revoked commitment/HTLC tx
4984         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4985         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
4986         check_closed_broadcast!(nodes[0], true);
4987         check_added_monitors!(nodes[0], 1);
4988         check_closed_event!(nodes[0], 1);
4989
4990         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4991         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4992
4993         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4994         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
4995         // transactions next...
4996         assert_eq!(node_txn[0].input.len(), 2);
4997         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4998         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4999                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5000         } else {
5001                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5002                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5003         }
5004
5005         assert_eq!(node_txn[1].input.len(), 1);
5006         check_spends!(node_txn[1], revoked_htlc_txn[0]);
5007
5008         check_spends!(node_txn[2], chan_1.3);
5009
5010         mine_transaction(&nodes[0], &node_txn[1]);
5011         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5012
5013         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5014         // didn't try to generate any new transactions.
5015
5016         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5017         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5018         assert_eq!(spend_txn.len(), 3);
5019         assert_eq!(spend_txn[0].input.len(), 1);
5020         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5021         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5022         check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5023         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5024 }
5025
5026 #[test]
5027 fn test_onchain_to_onchain_claim() {
5028         // Test that in case of channel closure, we detect the state of output and claim HTLC
5029         // on downstream peer's remote commitment tx.
5030         // First, have C claim an HTLC against its own latest commitment transaction.
5031         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5032         // channel.
5033         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5034         // gets broadcast.
5035
5036         let chanmon_cfgs = create_chanmon_cfgs(3);
5037         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5038         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5039         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5040
5041         // Create some initial channels
5042         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5043         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5044
5045         // Ensure all nodes are at the same height
5046         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5047         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5048         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5049         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5050
5051         // Rebalance the network a bit by relaying one payment through all the channels ...
5052         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5053         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5054
5055         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5056         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5057         check_spends!(commitment_tx[0], chan_2.3);
5058         nodes[2].node.claim_funds(payment_preimage);
5059         check_added_monitors!(nodes[2], 1);
5060         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5061         assert!(updates.update_add_htlcs.is_empty());
5062         assert!(updates.update_fail_htlcs.is_empty());
5063         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5064         assert!(updates.update_fail_malformed_htlcs.is_empty());
5065
5066         mine_transaction(&nodes[2], &commitment_tx[0]);
5067         check_closed_broadcast!(nodes[2], true);
5068         check_added_monitors!(nodes[2], 1);
5069         check_closed_event!(nodes[2], 1);
5070
5071         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5072         assert_eq!(c_txn.len(), 3);
5073         assert_eq!(c_txn[0], c_txn[2]);
5074         assert_eq!(commitment_tx[0], c_txn[1]);
5075         check_spends!(c_txn[1], chan_2.3);
5076         check_spends!(c_txn[2], c_txn[1]);
5077         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5078         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5079         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5080         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5081
5082         // 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
5083         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5084         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5085         check_added_monitors!(nodes[1], 1);
5086         let events = nodes[1].node.get_and_clear_pending_events();
5087         assert_eq!(events.len(), 2);
5088         match events[0] {
5089                 Event::ChannelClosed { .. } => {}
5090                 _ => panic!("Unexpected event"),
5091         }
5092         match events[1] {
5093                 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
5094                         assert_eq!(fee_earned_msat, Some(1000));
5095                         assert_eq!(claim_from_onchain_tx, true);
5096                 },
5097                 _ => panic!("Unexpected event"),
5098         }
5099         {
5100                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5101                 // ChannelMonitor: claim tx
5102                 assert_eq!(b_txn.len(), 1);
5103                 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
5104                 b_txn.clear();
5105         }
5106         check_added_monitors!(nodes[1], 1);
5107         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5108         assert_eq!(msg_events.len(), 3);
5109         match msg_events[0] {
5110                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5111                 _ => panic!("Unexpected event"),
5112         }
5113         match msg_events[1] {
5114                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5115                 _ => panic!("Unexpected event"),
5116         }
5117         match msg_events[2] {
5118                 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, .. } } => {
5119                         assert!(update_add_htlcs.is_empty());
5120                         assert!(update_fail_htlcs.is_empty());
5121                         assert_eq!(update_fulfill_htlcs.len(), 1);
5122                         assert!(update_fail_malformed_htlcs.is_empty());
5123                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5124                 },
5125                 _ => panic!("Unexpected event"),
5126         };
5127         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5128         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5129         mine_transaction(&nodes[1], &commitment_tx[0]);
5130         check_closed_event!(nodes[1], 1);
5131         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5132         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5133         assert_eq!(b_txn.len(), 3);
5134         check_spends!(b_txn[1], chan_1.3);
5135         check_spends!(b_txn[2], b_txn[1]);
5136         check_spends!(b_txn[0], commitment_tx[0]);
5137         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5138         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5139         assert_eq!(b_txn[0].lock_time, 0); // Success tx
5140
5141         check_closed_broadcast!(nodes[1], true);
5142         check_added_monitors!(nodes[1], 1);
5143 }
5144
5145 #[test]
5146 fn test_duplicate_payment_hash_one_failure_one_success() {
5147         // Topology : A --> B --> C --> D
5148         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5149         // Note that because C will refuse to generate two payment secrets for the same payment hash,
5150         // we forward one of the payments onwards to D.
5151         let chanmon_cfgs = create_chanmon_cfgs(4);
5152         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5153         // When this test was written, the default base fee floated based on the HTLC count.
5154         // It is now fixed, so we simply set the fee to the expected value here.
5155         let mut config = test_default_channel_config();
5156         config.channel_options.forwarding_fee_base_msat = 196;
5157         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs,
5158                 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5159         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5160
5161         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5162         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5163         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5164
5165         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5166         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5167         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5168         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5169         connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
5170
5171         let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5172
5173         let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5174         // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5175         // script push size limit so that the below script length checks match
5176         // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5177         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph,
5178                 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV - 40, nodes[0].logger).unwrap();
5179         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5180
5181         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5182         assert_eq!(commitment_txn[0].input.len(), 1);
5183         check_spends!(commitment_txn[0], chan_2.3);
5184
5185         mine_transaction(&nodes[1], &commitment_txn[0]);
5186         check_closed_broadcast!(nodes[1], true);
5187         check_added_monitors!(nodes[1], 1);
5188         check_closed_event!(nodes[1], 1);
5189         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
5190
5191         let htlc_timeout_tx;
5192         { // Extract one of the two HTLC-Timeout transaction
5193                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5194                 // ChannelMonitor: timeout tx * 3, ChannelManager: local commitment tx
5195                 assert_eq!(node_txn.len(), 4);
5196                 check_spends!(node_txn[0], chan_2.3);
5197
5198                 check_spends!(node_txn[1], commitment_txn[0]);
5199                 assert_eq!(node_txn[1].input.len(), 1);
5200                 check_spends!(node_txn[2], commitment_txn[0]);
5201                 assert_eq!(node_txn[2].input.len(), 1);
5202                 assert_eq!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
5203                 check_spends!(node_txn[3], commitment_txn[0]);
5204                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[3].input[0].previous_output);
5205
5206                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5207                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5208                 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5209                 htlc_timeout_tx = node_txn[1].clone();
5210         }
5211
5212         nodes[2].node.claim_funds(our_payment_preimage);
5213         mine_transaction(&nodes[2], &commitment_txn[0]);
5214         check_added_monitors!(nodes[2], 2);
5215         check_closed_event!(nodes[2], 1);
5216         let events = nodes[2].node.get_and_clear_pending_msg_events();
5217         match events[0] {
5218                 MessageSendEvent::UpdateHTLCs { .. } => {},
5219                 _ => panic!("Unexpected event"),
5220         }
5221         match events[1] {
5222                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5223                 _ => panic!("Unexepected event"),
5224         }
5225         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5226         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)
5227         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5228         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5229         assert_eq!(htlc_success_txn[0].input.len(), 1);
5230         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5231         assert_eq!(htlc_success_txn[1].input.len(), 1);
5232         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5233         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5234         assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5235         assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5236         assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5237         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5238
5239         mine_transaction(&nodes[1], &htlc_timeout_tx);
5240         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5241         let events = nodes[1].node.get_and_clear_pending_events();
5242         expect_pending_htlcs_forwardable!(nodes[1], events);
5243         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5244         assert!(htlc_updates.update_add_htlcs.is_empty());
5245         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5246         let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5247         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5248         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5249         check_added_monitors!(nodes[1], 1);
5250
5251         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5252         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5253         {
5254                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5255         }
5256         expect_payment_failed_with_update!(nodes[0], duplicate_payment_hash, false, chan_2.0.contents.short_channel_id, true);
5257
5258         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5259         // Note that the fee paid is effectively double as the HTLC value (including the nodes[1] fee
5260         // and nodes[2] fee) is rounded down and then claimed in full.
5261         mine_transaction(&nodes[1], &htlc_success_txn[0]);
5262         expect_payment_forwarded!(nodes[1], Some(196*2), true);
5263         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].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_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5268         assert!(updates.update_fail_malformed_htlcs.is_empty());
5269         check_added_monitors!(nodes[1], 1);
5270
5271         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5272         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5273
5274         let events = nodes[0].node.get_and_clear_pending_events();
5275         match events[0] {
5276                 Event::PaymentSent { ref payment_preimage } => {
5277                         assert_eq!(*payment_preimage, our_payment_preimage);
5278                 }
5279                 _ => panic!("Unexpected event"),
5280         }
5281 }
5282
5283 #[test]
5284 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5285         let chanmon_cfgs = create_chanmon_cfgs(2);
5286         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5287         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5288         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5289
5290         // Create some initial channels
5291         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5292
5293         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5294         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5295         assert_eq!(local_txn.len(), 1);
5296         assert_eq!(local_txn[0].input.len(), 1);
5297         check_spends!(local_txn[0], chan_1.3);
5298
5299         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5300         nodes[1].node.claim_funds(payment_preimage);
5301         check_added_monitors!(nodes[1], 1);
5302         mine_transaction(&nodes[1], &local_txn[0]);
5303         check_added_monitors!(nodes[1], 1);
5304         check_closed_event!(nodes[1], 1);
5305         let events = nodes[1].node.get_and_clear_pending_msg_events();
5306         match events[0] {
5307                 MessageSendEvent::UpdateHTLCs { .. } => {},
5308                 _ => panic!("Unexpected event"),
5309         }
5310         match events[1] {
5311                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5312                 _ => panic!("Unexepected event"),
5313         }
5314         let node_tx = {
5315                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5316                 assert_eq!(node_txn.len(), 3);
5317                 assert_eq!(node_txn[0], node_txn[2]);
5318                 assert_eq!(node_txn[1], local_txn[0]);
5319                 assert_eq!(node_txn[0].input.len(), 1);
5320                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5321                 check_spends!(node_txn[0], local_txn[0]);
5322                 node_txn[0].clone()
5323         };
5324
5325         mine_transaction(&nodes[1], &node_tx);
5326         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
5327
5328         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5329         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5330         assert_eq!(spend_txn.len(), 1);
5331         assert_eq!(spend_txn[0].input.len(), 1);
5332         check_spends!(spend_txn[0], node_tx);
5333         assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5334 }
5335
5336 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5337         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5338         // unrevoked commitment transaction.
5339         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5340         // a remote RAA before they could be failed backwards (and combinations thereof).
5341         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5342         // use the same payment hashes.
5343         // Thus, we use a six-node network:
5344         //
5345         // A \         / E
5346         //    - C - D -
5347         // B /         \ F
5348         // And test where C fails back to A/B when D announces its latest commitment transaction
5349         let chanmon_cfgs = create_chanmon_cfgs(6);
5350         let node_cfgs = create_node_cfgs(6, &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(6, &node_cfgs,
5356                 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5357         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5358         let logger = test_utils::TestLogger::new();
5359
5360         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5361         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5362         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5363         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5364         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5365
5366         // Rebalance and check output sanity...
5367         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5368         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5369         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5370
5371         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5372         // 0th HTLC:
5373         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
5374         // 1st HTLC:
5375         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
5376         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5377         let our_node_id = &nodes[1].node.get_our_node_id();
5378         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph, &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5379         // 2nd HTLC:
5380         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
5381         // 3rd HTLC:
5382         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
5383         // 4th HTLC:
5384         let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5385         // 5th HTLC:
5386         let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5387         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph, &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5388         // 6th HTLC:
5389         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());
5390         // 7th HTLC:
5391         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());
5392
5393         // 8th HTLC:
5394         let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5395         // 9th HTLC:
5396         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph, &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5397         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
5398
5399         // 10th HTLC:
5400         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
5401         // 11th HTLC:
5402         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph, &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5403         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());
5404
5405         // Double-check that six of the new HTLC were added
5406         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5407         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5408         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5409         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5410
5411         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5412         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5413         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5414         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5415         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5416         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5417         check_added_monitors!(nodes[4], 0);
5418         let events = nodes[4].node.get_and_clear_pending_events();
5419         expect_pending_htlcs_forwardable!(nodes[4], events);
5420         check_added_monitors!(nodes[4], 1);
5421
5422         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5423         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5424         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5425         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5426         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5427         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5428
5429         // Fail 3rd below-dust and 7th above-dust HTLCs
5430         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5431         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5432         check_added_monitors!(nodes[5], 0);
5433         let events = nodes[5].node.get_and_clear_pending_events();
5434         expect_pending_htlcs_forwardable!(nodes[5], events);
5435         check_added_monitors!(nodes[5], 1);
5436
5437         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5438         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5439         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5440         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5441
5442         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5443
5444         let events = nodes[3].node.get_and_clear_pending_events();
5445         expect_pending_htlcs_forwardable!(nodes[3], events);
5446         check_added_monitors!(nodes[3], 1);
5447         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5448         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5449         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5450         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5451         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5452         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5453         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5454         if deliver_last_raa {
5455                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5456         } else {
5457                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5458         }
5459
5460         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5461         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5462         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5463         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5464         //
5465         // We now broadcast the latest commitment transaction, which *should* result in failures for
5466         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5467         // the non-broadcast above-dust HTLCs.
5468         //
5469         // Alternatively, we may broadcast the previous commitment transaction, which should only
5470         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5471         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5472
5473         if announce_latest {
5474                 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5475                 let events = nodes[2].node.get_and_clear_pending_events();
5476                 if deliver_last_raa {
5477                         assert_eq!(events.len(), 2);
5478                         match events[1] {
5479                                 Event::ChannelClosed { .. } => {}
5480                                 _ => panic!("Unexpected event"),
5481                         }
5482                         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5483                         check_closed_broadcast!(nodes[2], true);
5484                         expect_pending_htlcs_forwardable!(nodes[2], events[0..1]);
5485                 } else {
5486                         assert_eq!(events.len(), 1);
5487                         match events[0] {
5488                                 Event::ChannelClosed { .. } => {}
5489                                 _ => panic!("Unexpected event"),
5490                         }
5491                         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5492                         check_closed_broadcast!(nodes[2], true);
5493                         let events = nodes[2].node.get_and_clear_pending_events();
5494                         expect_pending_htlcs_forwardable!(nodes[2], events);
5495                 }
5496         } else {
5497                 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5498                 let events = nodes[2].node.get_and_clear_pending_events();
5499                 if deliver_last_raa {
5500                         assert_eq!(events.len(), 2);
5501                         match events[1] {
5502                                 Event::ChannelClosed { .. } => {}
5503                                 _ => panic!("Unexpected event"),
5504                         }
5505                         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5506                         check_closed_broadcast!(nodes[2], true);
5507                         expect_pending_htlcs_forwardable!(nodes[2], events[0..1]);
5508                 } else {
5509                         assert_eq!(events.len(), 1);
5510                         match events[0] {
5511                                 Event::ChannelClosed { .. } => {}
5512                                 _ => panic!("Unexpected event"),
5513                         }
5514                         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5515                         check_closed_broadcast!(nodes[2], true);
5516                         let events = nodes[2].node.get_and_clear_pending_events();
5517                         expect_pending_htlcs_forwardable!(nodes[2], events);
5518                 }
5519         }
5520         check_added_monitors!(nodes[2], 3);
5521
5522         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5523         assert_eq!(cs_msgs.len(), 2);
5524         let mut a_done = false;
5525         for msg in cs_msgs {
5526                 match msg {
5527                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5528                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5529                                 // should be failed-backwards here.
5530                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5531                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5532                                         for htlc in &updates.update_fail_htlcs {
5533                                                 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 });
5534                                         }
5535                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5536                                         assert!(!a_done);
5537                                         a_done = true;
5538                                         &nodes[0]
5539                                 } else {
5540                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5541                                         for htlc in &updates.update_fail_htlcs {
5542                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5543                                         }
5544                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5545                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5546                                         &nodes[1]
5547                                 };
5548                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5549                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5550                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5551                                 if announce_latest {
5552                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5553                                         if *node_id == nodes[0].node.get_our_node_id() {
5554                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5555                                         }
5556                                 }
5557                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5558                         },
5559                         _ => panic!("Unexpected event"),
5560                 }
5561         }
5562
5563         let as_events = nodes[0].node.get_and_clear_pending_events();
5564         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5565         let mut as_failds = HashSet::new();
5566         let mut as_updates = 0;
5567         for event in as_events.iter() {
5568                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref network_update, .. } = event {
5569                         assert!(as_failds.insert(*payment_hash));
5570                         if *payment_hash != payment_hash_2 {
5571                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5572                         } else {
5573                                 assert!(!rejected_by_dest);
5574                         }
5575                         if network_update.is_some() {
5576                                 as_updates += 1;
5577                         }
5578                 } else { panic!("Unexpected event"); }
5579         }
5580         assert!(as_failds.contains(&payment_hash_1));
5581         assert!(as_failds.contains(&payment_hash_2));
5582         if announce_latest {
5583                 assert!(as_failds.contains(&payment_hash_3));
5584                 assert!(as_failds.contains(&payment_hash_5));
5585         }
5586         assert!(as_failds.contains(&payment_hash_6));
5587
5588         let bs_events = nodes[1].node.get_and_clear_pending_events();
5589         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5590         let mut bs_failds = HashSet::new();
5591         let mut bs_updates = 0;
5592         for event in bs_events.iter() {
5593                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref network_update, .. } = event {
5594                         assert!(bs_failds.insert(*payment_hash));
5595                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5596                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5597                         } else {
5598                                 assert!(!rejected_by_dest);
5599                         }
5600                         if network_update.is_some() {
5601                                 bs_updates += 1;
5602                         }
5603                 } else { panic!("Unexpected event"); }
5604         }
5605         assert!(bs_failds.contains(&payment_hash_1));
5606         assert!(bs_failds.contains(&payment_hash_2));
5607         if announce_latest {
5608                 assert!(bs_failds.contains(&payment_hash_4));
5609         }
5610         assert!(bs_failds.contains(&payment_hash_5));
5611
5612         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5613         // get a NetworkUpdate. A should have gotten 4 HTLCs which were failed-back due to
5614         // unknown-preimage-etc, B should have gotten 2. Thus, in the
5615         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2 NetworkUpdates.
5616         assert_eq!(as_updates, if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5617         assert_eq!(bs_updates, if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5618 }
5619
5620 #[test]
5621 fn test_fail_backwards_latest_remote_announce_a() {
5622         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5623 }
5624
5625 #[test]
5626 fn test_fail_backwards_latest_remote_announce_b() {
5627         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5628 }
5629
5630 #[test]
5631 fn test_fail_backwards_previous_remote_announce() {
5632         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5633         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5634         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5635 }
5636
5637 #[test]
5638 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5639         let chanmon_cfgs = create_chanmon_cfgs(2);
5640         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5641         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5642         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5643
5644         // Create some initial channels
5645         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5646
5647         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5648         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5649         assert_eq!(local_txn[0].input.len(), 1);
5650         check_spends!(local_txn[0], chan_1.3);
5651
5652         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5653         mine_transaction(&nodes[0], &local_txn[0]);
5654         check_closed_broadcast!(nodes[0], true);
5655         check_added_monitors!(nodes[0], 1);
5656         check_closed_event!(nodes[0], 1);
5657         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5658
5659         let htlc_timeout = {
5660                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5661                 assert_eq!(node_txn.len(), 2);
5662                 check_spends!(node_txn[0], chan_1.3);
5663                 assert_eq!(node_txn[1].input.len(), 1);
5664                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5665                 check_spends!(node_txn[1], local_txn[0]);
5666                 node_txn[1].clone()
5667         };
5668
5669         mine_transaction(&nodes[0], &htlc_timeout);
5670         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5671         let events = nodes[0].node.get_and_clear_pending_events();
5672         expect_payment_failed!(nodes[0], events, our_payment_hash, true);
5673
5674         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5675         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5676         assert_eq!(spend_txn.len(), 3);
5677         check_spends!(spend_txn[0], local_txn[0]);
5678         assert_eq!(spend_txn[1].input.len(), 1);
5679         check_spends!(spend_txn[1], htlc_timeout);
5680         assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5681         assert_eq!(spend_txn[2].input.len(), 2);
5682         check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5683         assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5684                 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5685 }
5686
5687 #[test]
5688 fn test_key_derivation_params() {
5689         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5690         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5691         // let us re-derive the channel key set to then derive a delayed_payment_key.
5692
5693         let chanmon_cfgs = create_chanmon_cfgs(3);
5694
5695         // We manually create the node configuration to backup the seed.
5696         let seed = [42; 32];
5697         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5698         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);
5699         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, features: InitFeatures::known() };
5700         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5701         node_cfgs.remove(0);
5702         node_cfgs.insert(0, node);
5703
5704         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5705         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5706
5707         // Create some initial channels
5708         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5709         // for node 0
5710         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5711         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5712         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5713
5714         // Ensure all nodes are at the same height
5715         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5716         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5717         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5718         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5719
5720         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5721         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5722         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5723         assert_eq!(local_txn_1[0].input.len(), 1);
5724         check_spends!(local_txn_1[0], chan_1.3);
5725
5726         // We check funding pubkey are unique
5727         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]));
5728         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]));
5729         if from_0_funding_key_0 == from_1_funding_key_0
5730             || from_0_funding_key_0 == from_1_funding_key_1
5731             || from_0_funding_key_1 == from_1_funding_key_0
5732             || from_0_funding_key_1 == from_1_funding_key_1 {
5733                 panic!("Funding pubkeys aren't unique");
5734         }
5735
5736         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5737         mine_transaction(&nodes[0], &local_txn_1[0]);
5738         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5739         check_closed_broadcast!(nodes[0], true);
5740         check_added_monitors!(nodes[0], 1);
5741         check_closed_event!(nodes[0], 1);
5742
5743         let htlc_timeout = {
5744                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5745                 assert_eq!(node_txn[1].input.len(), 1);
5746                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5747                 check_spends!(node_txn[1], local_txn_1[0]);
5748                 node_txn[1].clone()
5749         };
5750
5751         mine_transaction(&nodes[0], &htlc_timeout);
5752         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5753         let events = nodes[0].node.get_and_clear_pending_events();
5754         expect_payment_failed!(nodes[0], events, our_payment_hash, true);
5755
5756         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5757         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5758         let spend_txn = check_spendable_outputs!(nodes[0], new_keys_manager);
5759         assert_eq!(spend_txn.len(), 3);
5760         check_spends!(spend_txn[0], local_txn_1[0]);
5761         assert_eq!(spend_txn[1].input.len(), 1);
5762         check_spends!(spend_txn[1], htlc_timeout);
5763         assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5764         assert_eq!(spend_txn[2].input.len(), 2);
5765         check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5766         assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5767                 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5768 }
5769
5770 #[test]
5771 fn test_static_output_closing_tx() {
5772         let chanmon_cfgs = create_chanmon_cfgs(2);
5773         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5774         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5775         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5776
5777         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5778
5779         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5780         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5781
5782         mine_transaction(&nodes[0], &closing_tx);
5783         check_closed_event!(nodes[0], 1);
5784         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5785
5786         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5787         assert_eq!(spend_txn.len(), 1);
5788         check_spends!(spend_txn[0], closing_tx);
5789
5790         mine_transaction(&nodes[1], &closing_tx);
5791         check_closed_event!(nodes[1], 1);
5792         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5793
5794         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5795         assert_eq!(spend_txn.len(), 1);
5796         check_spends!(spend_txn[0], closing_tx);
5797 }
5798
5799 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5800         let chanmon_cfgs = create_chanmon_cfgs(2);
5801         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5802         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5803         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5804         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5805
5806         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5807
5808         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5809         // present in B's local commitment transaction, but none of A's commitment transactions.
5810         assert!(nodes[1].node.claim_funds(our_payment_preimage));
5811         check_added_monitors!(nodes[1], 1);
5812
5813         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5814         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5815         let events = nodes[0].node.get_and_clear_pending_events();
5816         assert_eq!(events.len(), 1);
5817         match events[0] {
5818                 Event::PaymentSent { payment_preimage } => {
5819                         assert_eq!(payment_preimage, our_payment_preimage);
5820                 },
5821                 _ => panic!("Unexpected event"),
5822         }
5823
5824         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5825         check_added_monitors!(nodes[0], 1);
5826         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5827         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5828         check_added_monitors!(nodes[1], 1);
5829
5830         let starting_block = nodes[1].best_block_info();
5831         let mut block = Block {
5832                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5833                 txdata: vec![],
5834         };
5835         for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5836                 connect_block(&nodes[1], &block);
5837                 block.header.prev_blockhash = block.block_hash();
5838         }
5839         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5840         check_closed_broadcast!(nodes[1], true);
5841         check_added_monitors!(nodes[1], 1);
5842         check_closed_event!(nodes[1], 1);
5843 }
5844
5845 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5846         let chanmon_cfgs = create_chanmon_cfgs(2);
5847         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5848         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5849         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5850         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5851         let logger = test_utils::TestLogger::new();
5852
5853         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
5854         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5855         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV, &logger).unwrap();
5856         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5857         check_added_monitors!(nodes[0], 1);
5858
5859         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5860
5861         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5862         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5863         // to "time out" the HTLC.
5864
5865         let starting_block = nodes[1].best_block_info();
5866         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5867
5868         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5869                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5870                 header.prev_blockhash = header.block_hash();
5871         }
5872         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5873         check_closed_broadcast!(nodes[0], true);
5874         check_added_monitors!(nodes[0], 1);
5875         check_closed_event!(nodes[0], 1);
5876 }
5877
5878 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5879         let chanmon_cfgs = create_chanmon_cfgs(3);
5880         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5881         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5882         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5883         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5884
5885         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5886         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5887         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5888         // actually revoked.
5889         let htlc_value = if use_dust { 50000 } else { 3000000 };
5890         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5891         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
5892         let events = nodes[1].node.get_and_clear_pending_events();
5893         expect_pending_htlcs_forwardable!(nodes[1], events);
5894         check_added_monitors!(nodes[1], 1);
5895
5896         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5897         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5898         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5899         check_added_monitors!(nodes[0], 1);
5900         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5901         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5902         check_added_monitors!(nodes[1], 1);
5903         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5904         check_added_monitors!(nodes[1], 1);
5905         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5906
5907         if check_revoke_no_close {
5908                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5909                 check_added_monitors!(nodes[0], 1);
5910         }
5911
5912         let starting_block = nodes[1].best_block_info();
5913         let mut block = Block {
5914                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5915                 txdata: vec![],
5916         };
5917         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
5918                 connect_block(&nodes[0], &block);
5919                 block.header.prev_blockhash = block.block_hash();
5920         }
5921         if !check_revoke_no_close {
5922                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5923                 check_closed_broadcast!(nodes[0], true);
5924                 check_added_monitors!(nodes[0], 1);
5925                 check_closed_event!(nodes[0], 1);
5926         } else {
5927                 let events = nodes[0].node.get_and_clear_pending_events();
5928                 expect_payment_failed!(nodes[0], events, our_payment_hash, true);
5929         }
5930 }
5931
5932 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5933 // There are only a few cases to test here:
5934 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5935 //    broadcastable commitment transactions result in channel closure,
5936 //  * its included in an unrevoked-but-previous remote commitment transaction,
5937 //  * its included in the latest remote or local commitment transactions.
5938 // We test each of the three possible commitment transactions individually and use both dust and
5939 // non-dust HTLCs.
5940 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5941 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5942 // tested for at least one of the cases in other tests.
5943 #[test]
5944 fn htlc_claim_single_commitment_only_a() {
5945         do_htlc_claim_local_commitment_only(true);
5946         do_htlc_claim_local_commitment_only(false);
5947
5948         do_htlc_claim_current_remote_commitment_only(true);
5949         do_htlc_claim_current_remote_commitment_only(false);
5950 }
5951
5952 #[test]
5953 fn htlc_claim_single_commitment_only_b() {
5954         do_htlc_claim_previous_remote_commitment_only(true, false);
5955         do_htlc_claim_previous_remote_commitment_only(false, false);
5956         do_htlc_claim_previous_remote_commitment_only(true, true);
5957         do_htlc_claim_previous_remote_commitment_only(false, true);
5958 }
5959
5960 #[test]
5961 #[should_panic]
5962 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5963         let chanmon_cfgs = create_chanmon_cfgs(2);
5964         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5965         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5966         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5967         //Force duplicate channel ids
5968         for node in nodes.iter() {
5969                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5970         }
5971
5972         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5973         let channel_value_satoshis=10000;
5974         let push_msat=10001;
5975         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5976         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5977         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
5978
5979         //Create a second channel with a channel_id collision
5980         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5981 }
5982
5983 #[test]
5984 fn bolt2_open_channel_sending_node_checks_part2() {
5985         let chanmon_cfgs = create_chanmon_cfgs(2);
5986         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5987         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5988         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5989
5990         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5991         let channel_value_satoshis=2^24;
5992         let push_msat=10001;
5993         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5994
5995         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5996         let channel_value_satoshis=10000;
5997         // Test when push_msat is equal to 1000 * funding_satoshis.
5998         let push_msat=1000*channel_value_satoshis+1;
5999         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6000
6001         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6002         let channel_value_satoshis=10000;
6003         let push_msat=10001;
6004         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
6005         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6006         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6007
6008         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6009         // 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
6010         assert!(node0_to_1_send_open_channel.channel_flags<=1);
6011
6012         // 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.
6013         assert!(BREAKDOWN_TIMEOUT>0);
6014         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6015
6016         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6017         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6018         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6019
6020         // 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.
6021         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6022         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6023         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6024         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6025         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6026 }
6027
6028 #[test]
6029 fn bolt2_open_channel_sane_dust_limit() {
6030         let chanmon_cfgs = create_chanmon_cfgs(2);
6031         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6032         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6033         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6034
6035         let channel_value_satoshis=1000000;
6036         let push_msat=10001;
6037         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6038         let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6039         node0_to_1_send_open_channel.dust_limit_satoshis = 661;
6040         node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
6041
6042         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6043         let events = nodes[1].node.get_and_clear_pending_msg_events();
6044         let err_msg = match events[0] {
6045                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
6046                         msg.clone()
6047                 },
6048                 _ => panic!("Unexpected event"),
6049         };
6050         assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
6051 }
6052
6053 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6054 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6055 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6056 // is no longer affordable once it's freed.
6057 #[test]
6058 fn test_fail_holding_cell_htlc_upon_free() {
6059         let chanmon_cfgs = create_chanmon_cfgs(2);
6060         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6061         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6062         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6063         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6064         let logger = test_utils::TestLogger::new();
6065
6066         // First nodes[0] generates an update_fee, setting the channel's
6067         // pending_update_fee.
6068         {
6069                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
6070                 *feerate_lock += 20;
6071         }
6072         nodes[0].node.timer_tick_occurred();
6073         check_added_monitors!(nodes[0], 1);
6074
6075         let events = nodes[0].node.get_and_clear_pending_msg_events();
6076         assert_eq!(events.len(), 1);
6077         let (update_msg, commitment_signed) = match events[0] {
6078                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6079                         (update_fee.as_ref(), commitment_signed)
6080                 },
6081                 _ => panic!("Unexpected event"),
6082         };
6083
6084         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6085
6086         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6087         let channel_reserve = chan_stat.channel_reserve_msat;
6088         let feerate = get_feerate!(nodes[0], chan.2);
6089
6090         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6091         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6092         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6093         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6094         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6095
6096         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6097         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6098         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6099         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6100
6101         // Flush the pending fee update.
6102         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6103         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6104         check_added_monitors!(nodes[1], 1);
6105         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6106         check_added_monitors!(nodes[0], 1);
6107
6108         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6109         // HTLC, but now that the fee has been raised the payment will now fail, causing
6110         // us to surface its failure to the user.
6111         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6112         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6113         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);
6114         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 {}",
6115                 hex::encode(our_payment_hash.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6116         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6117
6118         // Check that the payment failed to be sent out.
6119         let events = nodes[0].node.get_and_clear_pending_events();
6120         assert_eq!(events.len(), 1);
6121         match &events[0] {
6122                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref network_update, ref error_code, ref error_data, ref all_paths_failed } => {
6123                         assert_eq!(our_payment_hash.clone(), *payment_hash);
6124                         assert_eq!(*rejected_by_dest, false);
6125                         assert_eq!(*all_paths_failed, true);
6126                         assert_eq!(*network_update, None);
6127                         assert_eq!(*error_code, None);
6128                         assert_eq!(*error_data, None);
6129                 },
6130                 _ => panic!("Unexpected event"),
6131         }
6132 }
6133
6134 // Test that if multiple HTLCs are released from the holding cell and one is
6135 // valid but the other is no longer valid upon release, the valid HTLC can be
6136 // successfully completed while the other one fails as expected.
6137 #[test]
6138 fn test_free_and_fail_holding_cell_htlcs() {
6139         let chanmon_cfgs = create_chanmon_cfgs(2);
6140         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6141         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6142         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6143         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6144         let logger = test_utils::TestLogger::new();
6145
6146         // First nodes[0] generates an update_fee, setting the channel's
6147         // pending_update_fee.
6148         {
6149                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
6150                 *feerate_lock += 200;
6151         }
6152         nodes[0].node.timer_tick_occurred();
6153         check_added_monitors!(nodes[0], 1);
6154
6155         let events = nodes[0].node.get_and_clear_pending_msg_events();
6156         assert_eq!(events.len(), 1);
6157         let (update_msg, commitment_signed) = match events[0] {
6158                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6159                         (update_fee.as_ref(), commitment_signed)
6160                 },
6161                 _ => panic!("Unexpected event"),
6162         };
6163
6164         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6165
6166         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6167         let channel_reserve = chan_stat.channel_reserve_msat;
6168         let feerate = get_feerate!(nodes[0], chan.2);
6169
6170         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6171         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6172         let amt_1 = 20000;
6173         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6174         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6175         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6176         let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], amt_1, TEST_FINAL_CLTV, &logger).unwrap();
6177         let route_2 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], amt_2, TEST_FINAL_CLTV, &logger).unwrap();
6178
6179         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6180         nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6181         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6182         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6183         nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6184         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6185         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6186
6187         // Flush the pending fee update.
6188         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6189         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6190         check_added_monitors!(nodes[1], 1);
6191         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6192         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6193         check_added_monitors!(nodes[0], 2);
6194
6195         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6196         // but now that the fee has been raised the second payment will now fail, causing us
6197         // to surface its failure to the user. The first payment should succeed.
6198         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6199         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6200         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);
6201         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 {}",
6202                 hex::encode(payment_hash_2.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6203         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6204
6205         // Check that the second payment failed to be sent out.
6206         let events = nodes[0].node.get_and_clear_pending_events();
6207         assert_eq!(events.len(), 1);
6208         match &events[0] {
6209                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref network_update, ref error_code, ref error_data, ref all_paths_failed } => {
6210                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6211                         assert_eq!(*rejected_by_dest, false);
6212                         assert_eq!(*all_paths_failed, true);
6213                         assert_eq!(*network_update, None);
6214                         assert_eq!(*error_code, None);
6215                         assert_eq!(*error_data, None);
6216                 },
6217                 _ => panic!("Unexpected event"),
6218         }
6219
6220         // Complete the first payment and the RAA from the fee update.
6221         let (payment_event, send_raa_event) = {
6222                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6223                 assert_eq!(msgs.len(), 2);
6224                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6225         };
6226         let raa = match send_raa_event {
6227                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6228                 _ => panic!("Unexpected event"),
6229         };
6230         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6231         check_added_monitors!(nodes[1], 1);
6232         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6233         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6234         let events = nodes[1].node.get_and_clear_pending_events();
6235         assert_eq!(events.len(), 1);
6236         match events[0] {
6237                 Event::PendingHTLCsForwardable { .. } => {},
6238                 _ => panic!("Unexpected event"),
6239         }
6240         nodes[1].node.process_pending_htlc_forwards();
6241         let events = nodes[1].node.get_and_clear_pending_events();
6242         assert_eq!(events.len(), 1);
6243         match events[0] {
6244                 Event::PaymentReceived { .. } => {},
6245                 _ => panic!("Unexpected event"),
6246         }
6247         nodes[1].node.claim_funds(payment_preimage_1);
6248         check_added_monitors!(nodes[1], 1);
6249         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6250         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6251         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6252         let events = nodes[0].node.get_and_clear_pending_events();
6253         assert_eq!(events.len(), 1);
6254         match events[0] {
6255                 Event::PaymentSent { ref payment_preimage } => {
6256                         assert_eq!(*payment_preimage, payment_preimage_1);
6257                 }
6258                 _ => panic!("Unexpected event"),
6259         }
6260 }
6261
6262 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6263 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6264 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6265 // once it's freed.
6266 #[test]
6267 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6268         let chanmon_cfgs = create_chanmon_cfgs(3);
6269         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6270         // When this test was written, the default base fee floated based on the HTLC count.
6271         // It is now fixed, so we simply set the fee to the expected value here.
6272         let mut config = test_default_channel_config();
6273         config.channel_options.forwarding_fee_base_msat = 196;
6274         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
6275         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6276         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6277         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6278         let logger = test_utils::TestLogger::new();
6279
6280         // First nodes[1] generates an update_fee, setting the channel's
6281         // pending_update_fee.
6282         {
6283                 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
6284                 *feerate_lock += 20;
6285         }
6286         nodes[1].node.timer_tick_occurred();
6287         check_added_monitors!(nodes[1], 1);
6288
6289         let events = nodes[1].node.get_and_clear_pending_msg_events();
6290         assert_eq!(events.len(), 1);
6291         let (update_msg, commitment_signed) = match events[0] {
6292                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6293                         (update_fee.as_ref(), commitment_signed)
6294                 },
6295                 _ => panic!("Unexpected event"),
6296         };
6297
6298         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6299
6300         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6301         let channel_reserve = chan_stat.channel_reserve_msat;
6302         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6303
6304         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6305         let feemsat = 239;
6306         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6307         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6308         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6309         let payment_event = {
6310                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6311                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6312                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6313                 check_added_monitors!(nodes[0], 1);
6314
6315                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6316                 assert_eq!(events.len(), 1);
6317
6318                 SendEvent::from_event(events.remove(0))
6319         };
6320         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6321         check_added_monitors!(nodes[1], 0);
6322         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6323         let events = nodes[1].node.get_and_clear_pending_events();
6324         expect_pending_htlcs_forwardable!(nodes[1], events);
6325
6326         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6327         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6328
6329         // Flush the pending fee update.
6330         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6331         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6332         check_added_monitors!(nodes[2], 1);
6333         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6334         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6335         check_added_monitors!(nodes[1], 2);
6336
6337         // A final RAA message is generated to finalize the fee update.
6338         let events = nodes[1].node.get_and_clear_pending_msg_events();
6339         assert_eq!(events.len(), 1);
6340
6341         let raa_msg = match &events[0] {
6342                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6343                         msg.clone()
6344                 },
6345                 _ => panic!("Unexpected event"),
6346         };
6347
6348         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6349         check_added_monitors!(nodes[2], 1);
6350         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6351
6352         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6353         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6354         assert_eq!(process_htlc_forwards_event.len(), 1);
6355         match &process_htlc_forwards_event[0] {
6356                 &Event::PendingHTLCsForwardable { .. } => {},
6357                 _ => panic!("Unexpected event"),
6358         }
6359
6360         // In response, we call ChannelManager's process_pending_htlc_forwards
6361         nodes[1].node.process_pending_htlc_forwards();
6362         check_added_monitors!(nodes[1], 1);
6363
6364         // This causes the HTLC to be failed backwards.
6365         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6366         assert_eq!(fail_event.len(), 1);
6367         let (fail_msg, commitment_signed) = match &fail_event[0] {
6368                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6369                         assert_eq!(updates.update_add_htlcs.len(), 0);
6370                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6371                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6372                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6373                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6374                 },
6375                 _ => panic!("Unexpected event"),
6376         };
6377
6378         // Pass the failure messages back to nodes[0].
6379         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6380         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6381
6382         // Complete the HTLC failure+removal process.
6383         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6384         check_added_monitors!(nodes[0], 1);
6385         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6386         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6387         check_added_monitors!(nodes[1], 2);
6388         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6389         assert_eq!(final_raa_event.len(), 1);
6390         let raa = match &final_raa_event[0] {
6391                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6392                 _ => panic!("Unexpected event"),
6393         };
6394         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6395         expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_1_2.0.contents.short_channel_id, false);
6396         check_added_monitors!(nodes[0], 1);
6397 }
6398
6399 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6400 // 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.
6401 //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.
6402
6403 #[test]
6404 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6405         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6406         let chanmon_cfgs = create_chanmon_cfgs(2);
6407         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6408         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6409         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6410         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6411
6412         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6413         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6414         let logger = test_utils::TestLogger::new();
6415         let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6416         route.paths[0][0].fee_msat = 100;
6417
6418         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6419                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6420         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6421         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6422 }
6423
6424 #[test]
6425 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6426         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6427         let chanmon_cfgs = create_chanmon_cfgs(2);
6428         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6429         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6430         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6431         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6432         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6433
6434         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6435         let logger = test_utils::TestLogger::new();
6436         let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6437         route.paths[0][0].fee_msat = 0;
6438         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6439                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6440
6441         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6442         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6443 }
6444
6445 #[test]
6446 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6447         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6448         let chanmon_cfgs = create_chanmon_cfgs(2);
6449         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6450         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6451         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6452         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6453
6454         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6455         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6456         let logger = test_utils::TestLogger::new();
6457         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6458         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6459         check_added_monitors!(nodes[0], 1);
6460         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6461         updates.update_add_htlcs[0].amount_msat = 0;
6462
6463         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6464         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6465         check_closed_broadcast!(nodes[1], true).unwrap();
6466         check_added_monitors!(nodes[1], 1);
6467         check_closed_event!(nodes[1], 1);
6468 }
6469
6470 #[test]
6471 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6472         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6473         //It is enforced when constructing a route.
6474         let chanmon_cfgs = create_chanmon_cfgs(2);
6475         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6476         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6477         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6478         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6479         let logger = test_utils::TestLogger::new();
6480
6481         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6482
6483         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6484         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000000, 500000001, &logger).unwrap();
6485         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6486                 assert_eq!(err, &"Channel CLTV overflowed?"));
6487 }
6488
6489 #[test]
6490 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6491         //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.
6492         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6493         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6494         let chanmon_cfgs = create_chanmon_cfgs(2);
6495         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6496         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6497         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6498         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6499         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6500
6501         let logger = test_utils::TestLogger::new();
6502         for i in 0..max_accepted_htlcs {
6503                 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6504                 let payment_event = {
6505                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6506                         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6507                         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6508                         check_added_monitors!(nodes[0], 1);
6509
6510                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6511                         assert_eq!(events.len(), 1);
6512                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6513                                 assert_eq!(htlcs[0].htlc_id, i);
6514                         } else {
6515                                 assert!(false);
6516                         }
6517                         SendEvent::from_event(events.remove(0))
6518                 };
6519                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6520                 check_added_monitors!(nodes[1], 0);
6521                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6522
6523                 let events = nodes[1].node.get_and_clear_pending_events();
6524                 expect_pending_htlcs_forwardable!(nodes[1], events);
6525                 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6526         }
6527         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6528         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6529         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6530         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6531                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6532
6533         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6534         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6535 }
6536
6537 #[test]
6538 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6539         //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.
6540         let chanmon_cfgs = create_chanmon_cfgs(2);
6541         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6542         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6543         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6544         let channel_value = 100000;
6545         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6546         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6547
6548         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6549
6550         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6551         // Manually create a route over our max in flight (which our router normally automatically
6552         // limits us to.
6553         let route = Route { paths: vec![vec![RouteHop {
6554            pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6555            short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6556            fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6557         }]] };
6558         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6559                 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)));
6560
6561         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6562         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);
6563
6564         send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6565 }
6566
6567 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6568 #[test]
6569 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6570         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6571         let chanmon_cfgs = create_chanmon_cfgs(2);
6572         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6573         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6574         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6575         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6576         let htlc_minimum_msat: u64;
6577         {
6578                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6579                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6580                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6581         }
6582
6583         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6584         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6585         let logger = test_utils::TestLogger::new();
6586         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV, &logger).unwrap();
6587         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6588         check_added_monitors!(nodes[0], 1);
6589         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6590         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6591         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6592         assert!(nodes[1].node.list_channels().is_empty());
6593         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6594         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()));
6595         check_added_monitors!(nodes[1], 1);
6596         check_closed_event!(nodes[1], 1);
6597 }
6598
6599 #[test]
6600 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6601         //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
6602         let chanmon_cfgs = create_chanmon_cfgs(2);
6603         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6604         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6605         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6606         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6607         let logger = test_utils::TestLogger::new();
6608
6609         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6610         let channel_reserve = chan_stat.channel_reserve_msat;
6611         let feerate = get_feerate!(nodes[0], chan.2);
6612         // The 2* and +1 are for the fee spike reserve.
6613         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6614
6615         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6616         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6617         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6618         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6619         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6620         check_added_monitors!(nodes[0], 1);
6621         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6622
6623         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6624         // at this time channel-initiatee receivers are not required to enforce that senders
6625         // respect the fee_spike_reserve.
6626         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6627         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6628
6629         assert!(nodes[1].node.list_channels().is_empty());
6630         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6631         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6632         check_added_monitors!(nodes[1], 1);
6633         check_closed_event!(nodes[1], 1);
6634 }
6635
6636 #[test]
6637 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6638         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6639         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6640         let chanmon_cfgs = create_chanmon_cfgs(2);
6641         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6642         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6643         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6644         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6645         let logger = test_utils::TestLogger::new();
6646
6647         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6648         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6649
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, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 3999999, TEST_FINAL_CLTV, &logger).unwrap();
6652
6653         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6654         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6655         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height, &None).unwrap();
6656         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6657
6658         let mut msg = msgs::UpdateAddHTLC {
6659                 channel_id: chan.2,
6660                 htlc_id: 0,
6661                 amount_msat: 1000,
6662                 payment_hash: our_payment_hash,
6663                 cltv_expiry: htlc_cltv,
6664                 onion_routing_packet: onion_packet.clone(),
6665         };
6666
6667         for i in 0..super::channel::OUR_MAX_HTLCS {
6668                 msg.htlc_id = i as u64;
6669                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6670         }
6671         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6672         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6673
6674         assert!(nodes[1].node.list_channels().is_empty());
6675         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6676         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6677         check_added_monitors!(nodes[1], 1);
6678         check_closed_event!(nodes[1], 1);
6679 }
6680
6681 #[test]
6682 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6683         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6684         let chanmon_cfgs = create_chanmon_cfgs(2);
6685         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6686         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6687         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6688         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6689         let logger = test_utils::TestLogger::new();
6690
6691         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6692         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6693         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6694         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6695         check_added_monitors!(nodes[0], 1);
6696         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6697         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6698         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6699
6700         assert!(nodes[1].node.list_channels().is_empty());
6701         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6702         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6703         check_added_monitors!(nodes[1], 1);
6704         check_closed_event!(nodes[1], 1);
6705 }
6706
6707 #[test]
6708 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6709         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6710         let chanmon_cfgs = create_chanmon_cfgs(2);
6711         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6712         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6713         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6714         let logger = test_utils::TestLogger::new();
6715
6716         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6717         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6718         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6719         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6720         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6721         check_added_monitors!(nodes[0], 1);
6722         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6723         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6724         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6725
6726         assert!(nodes[1].node.list_channels().is_empty());
6727         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6728         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6729         check_added_monitors!(nodes[1], 1);
6730         check_closed_event!(nodes[1], 1);
6731 }
6732
6733 #[test]
6734 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6735         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6736         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6737         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6738         let chanmon_cfgs = create_chanmon_cfgs(2);
6739         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6740         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6741         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6742         let logger = test_utils::TestLogger::new();
6743
6744         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6745         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6746         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6747         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6748         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6749         check_added_monitors!(nodes[0], 1);
6750         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6751         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6752
6753         //Disconnect and Reconnect
6754         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6755         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6756         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6757         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6758         assert_eq!(reestablish_1.len(), 1);
6759         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6760         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6761         assert_eq!(reestablish_2.len(), 1);
6762         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6763         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6764         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6765         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6766
6767         //Resend HTLC
6768         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6769         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6770         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6771         check_added_monitors!(nodes[1], 1);
6772         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6773
6774         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6775
6776         assert!(nodes[1].node.list_channels().is_empty());
6777         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6778         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6779         check_added_monitors!(nodes[1], 1);
6780         check_closed_event!(nodes[1], 1);
6781 }
6782
6783 #[test]
6784 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6785         //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.
6786
6787         let chanmon_cfgs = create_chanmon_cfgs(2);
6788         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6789         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6790         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6791         let logger = test_utils::TestLogger::new();
6792         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6793         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6794         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6795         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6796         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6797
6798         check_added_monitors!(nodes[0], 1);
6799         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6800         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6801
6802         let update_msg = msgs::UpdateFulfillHTLC{
6803                 channel_id: chan.2,
6804                 htlc_id: 0,
6805                 payment_preimage: our_payment_preimage,
6806         };
6807
6808         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6809
6810         assert!(nodes[0].node.list_channels().is_empty());
6811         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6812         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()));
6813         check_added_monitors!(nodes[0], 1);
6814         check_closed_event!(nodes[0], 1);
6815 }
6816
6817 #[test]
6818 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6819         //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.
6820
6821         let chanmon_cfgs = create_chanmon_cfgs(2);
6822         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6823         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6824         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6825         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6826         let logger = test_utils::TestLogger::new();
6827
6828         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6829         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6830         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6831         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6832         check_added_monitors!(nodes[0], 1);
6833         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6834         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6835
6836         let update_msg = msgs::UpdateFailHTLC{
6837                 channel_id: chan.2,
6838                 htlc_id: 0,
6839                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6840         };
6841
6842         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6843
6844         assert!(nodes[0].node.list_channels().is_empty());
6845         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6846         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()));
6847         check_added_monitors!(nodes[0], 1);
6848         check_closed_event!(nodes[0], 1);
6849 }
6850
6851 #[test]
6852 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6853         //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.
6854
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 chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6860         let logger = test_utils::TestLogger::new();
6861
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, &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         let update_msg = msgs::UpdateFailMalformedHTLC{
6870                 channel_id: chan.2,
6871                 htlc_id: 0,
6872                 sha256_of_onion: [1; 32],
6873                 failure_code: 0x8000,
6874         };
6875
6876         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6877
6878         assert!(nodes[0].node.list_channels().is_empty());
6879         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6880         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()));
6881         check_added_monitors!(nodes[0], 1);
6882         check_closed_event!(nodes[0], 1);
6883 }
6884
6885 #[test]
6886 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6887         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6888
6889         let chanmon_cfgs = create_chanmon_cfgs(2);
6890         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6891         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6892         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6893         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6894
6895         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6896
6897         nodes[1].node.claim_funds(our_payment_preimage);
6898         check_added_monitors!(nodes[1], 1);
6899
6900         let events = nodes[1].node.get_and_clear_pending_msg_events();
6901         assert_eq!(events.len(), 1);
6902         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6903                 match events[0] {
6904                         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, .. } } => {
6905                                 assert!(update_add_htlcs.is_empty());
6906                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6907                                 assert!(update_fail_htlcs.is_empty());
6908                                 assert!(update_fail_malformed_htlcs.is_empty());
6909                                 assert!(update_fee.is_none());
6910                                 update_fulfill_htlcs[0].clone()
6911                         },
6912                         _ => panic!("Unexpected event"),
6913                 }
6914         };
6915
6916         update_fulfill_msg.htlc_id = 1;
6917
6918         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6919
6920         assert!(nodes[0].node.list_channels().is_empty());
6921         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6922         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6923         check_added_monitors!(nodes[0], 1);
6924         check_closed_event!(nodes[0], 1);
6925 }
6926
6927 #[test]
6928 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6929         //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.
6930
6931         let chanmon_cfgs = create_chanmon_cfgs(2);
6932         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6933         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6934         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6935         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6936
6937         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6938
6939         nodes[1].node.claim_funds(our_payment_preimage);
6940         check_added_monitors!(nodes[1], 1);
6941
6942         let events = nodes[1].node.get_and_clear_pending_msg_events();
6943         assert_eq!(events.len(), 1);
6944         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6945                 match events[0] {
6946                         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, .. } } => {
6947                                 assert!(update_add_htlcs.is_empty());
6948                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6949                                 assert!(update_fail_htlcs.is_empty());
6950                                 assert!(update_fail_malformed_htlcs.is_empty());
6951                                 assert!(update_fee.is_none());
6952                                 update_fulfill_htlcs[0].clone()
6953                         },
6954                         _ => panic!("Unexpected event"),
6955                 }
6956         };
6957
6958         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6959
6960         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6961
6962         assert!(nodes[0].node.list_channels().is_empty());
6963         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6964         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6965         check_added_monitors!(nodes[0], 1);
6966         check_closed_event!(nodes[0], 1);
6967 }
6968
6969 #[test]
6970 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6971         //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.
6972
6973         let chanmon_cfgs = create_chanmon_cfgs(2);
6974         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6975         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6976         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6977         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6978         let logger = test_utils::TestLogger::new();
6979
6980         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6981         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6982         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6983         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6984         check_added_monitors!(nodes[0], 1);
6985
6986         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6987         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6988
6989         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6990         check_added_monitors!(nodes[1], 0);
6991         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6992
6993         let events = nodes[1].node.get_and_clear_pending_msg_events();
6994
6995         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6996                 match events[0] {
6997                         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, .. } } => {
6998                                 assert!(update_add_htlcs.is_empty());
6999                                 assert!(update_fulfill_htlcs.is_empty());
7000                                 assert!(update_fail_htlcs.is_empty());
7001                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7002                                 assert!(update_fee.is_none());
7003                                 update_fail_malformed_htlcs[0].clone()
7004                         },
7005                         _ => panic!("Unexpected event"),
7006                 }
7007         };
7008         update_msg.failure_code &= !0x8000;
7009         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7010
7011         assert!(nodes[0].node.list_channels().is_empty());
7012         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7013         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7014         check_added_monitors!(nodes[0], 1);
7015         check_closed_event!(nodes[0], 1);
7016 }
7017
7018 #[test]
7019 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7020         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7021         //    * 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.
7022
7023         let chanmon_cfgs = create_chanmon_cfgs(3);
7024         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7025         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7026         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7027         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7028         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7029         let logger = test_utils::TestLogger::new();
7030
7031         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7032
7033         //First hop
7034         let mut payment_event = {
7035                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7036                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
7037                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7038                 check_added_monitors!(nodes[0], 1);
7039                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7040                 assert_eq!(events.len(), 1);
7041                 SendEvent::from_event(events.remove(0))
7042         };
7043         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7044         check_added_monitors!(nodes[1], 0);
7045         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7046         let events = nodes[1].node.get_and_clear_pending_events();
7047         expect_pending_htlcs_forwardable!(nodes[1], events);
7048         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7049         assert_eq!(events_2.len(), 1);
7050         check_added_monitors!(nodes[1], 1);
7051         payment_event = SendEvent::from_event(events_2.remove(0));
7052         assert_eq!(payment_event.msgs.len(), 1);
7053
7054         //Second Hop
7055         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7056         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7057         check_added_monitors!(nodes[2], 0);
7058         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7059
7060         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7061         assert_eq!(events_3.len(), 1);
7062         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7063                 match events_3[0] {
7064                         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 } } => {
7065                                 assert!(update_add_htlcs.is_empty());
7066                                 assert!(update_fulfill_htlcs.is_empty());
7067                                 assert!(update_fail_htlcs.is_empty());
7068                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7069                                 assert!(update_fee.is_none());
7070                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7071                         },
7072                         _ => panic!("Unexpected event"),
7073                 }
7074         };
7075
7076         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7077
7078         check_added_monitors!(nodes[1], 0);
7079         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7080         let events = nodes[1].node.get_and_clear_pending_events();
7081         expect_pending_htlcs_forwardable!(nodes[1], events);
7082         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7083         assert_eq!(events_4.len(), 1);
7084
7085         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7086         match events_4[0] {
7087                 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, .. } } => {
7088                         assert!(update_add_htlcs.is_empty());
7089                         assert!(update_fulfill_htlcs.is_empty());
7090                         assert_eq!(update_fail_htlcs.len(), 1);
7091                         assert!(update_fail_malformed_htlcs.is_empty());
7092                         assert!(update_fee.is_none());
7093                 },
7094                 _ => panic!("Unexpected event"),
7095         };
7096
7097         check_added_monitors!(nodes[1], 1);
7098 }
7099
7100 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7101         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7102         // 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
7103         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7104
7105         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7106         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7107         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7108         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7109         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7110         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7111
7112         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7113
7114         // We route 2 dust-HTLCs between A and B
7115         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7116         let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7117         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7118
7119         // Cache one local commitment tx as previous
7120         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7121
7122         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7123         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7124         check_added_monitors!(nodes[1], 0);
7125         let events = nodes[1].node.get_and_clear_pending_events();
7126         expect_pending_htlcs_forwardable!(nodes[1], events);
7127         check_added_monitors!(nodes[1], 1);
7128
7129         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7130         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7131         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7132         check_added_monitors!(nodes[0], 1);
7133
7134         // Cache one local commitment tx as lastest
7135         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7136
7137         let events = nodes[0].node.get_and_clear_pending_msg_events();
7138         match events[0] {
7139                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7140                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7141                 },
7142                 _ => panic!("Unexpected event"),
7143         }
7144         match events[1] {
7145                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7146                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7147                 },
7148                 _ => panic!("Unexpected event"),
7149         }
7150
7151         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7152         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7153         if announce_latest {
7154                 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7155         } else {
7156                 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7157         }
7158
7159         check_closed_broadcast!(nodes[0], true);
7160         check_added_monitors!(nodes[0], 1);
7161         check_closed_event!(nodes[0], 1);
7162
7163         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7164         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7165         let events = nodes[0].node.get_and_clear_pending_events();
7166         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7167         assert_eq!(events.len(), 2);
7168         let mut first_failed = false;
7169         for event in events {
7170                 match event {
7171                         Event::PaymentFailed { payment_hash, .. } => {
7172                                 if payment_hash == payment_hash_1 {
7173                                         assert!(!first_failed);
7174                                         first_failed = true;
7175                                 } else {
7176                                         assert_eq!(payment_hash, payment_hash_2);
7177                                 }
7178                         }
7179                         _ => panic!("Unexpected event"),
7180                 }
7181         }
7182 }
7183
7184 #[test]
7185 fn test_failure_delay_dust_htlc_local_commitment() {
7186         do_test_failure_delay_dust_htlc_local_commitment(true);
7187         do_test_failure_delay_dust_htlc_local_commitment(false);
7188 }
7189
7190 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7191         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7192         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7193         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7194         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7195         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7196         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7197
7198         let chanmon_cfgs = create_chanmon_cfgs(3);
7199         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7200         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7201         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7202         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7203
7204         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7205
7206         let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7207         let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7208
7209         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7210         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7211
7212         // We revoked bs_commitment_tx
7213         if revoked {
7214                 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7215                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7216         }
7217
7218         let mut timeout_tx = Vec::new();
7219         if local {
7220                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7221                 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7222                 check_closed_event!(nodes[0], 1);
7223                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7224                 let events = nodes[0].node.get_and_clear_pending_events();
7225                 expect_payment_failed!(nodes[0], events, dust_hash, true);
7226
7227                 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
7228                 check_closed_broadcast!(nodes[0], true);
7229                 check_added_monitors!(nodes[0], 1);
7230                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7231                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7232                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7233                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7234                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7235                 mine_transaction(&nodes[0], &timeout_tx[0]);
7236                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7237                 let events = nodes[0].node.get_and_clear_pending_events();
7238                 expect_payment_failed!(nodes[0], events, non_dust_hash, true);
7239         } else {
7240                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7241                 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7242                 check_closed_broadcast!(nodes[0], true);
7243                 check_added_monitors!(nodes[0], 1);
7244                 check_closed_event!(nodes[0], 1);
7245                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7246                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7247                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7248                 if !revoked {
7249                         let events = nodes[0].node.get_and_clear_pending_events();
7250                         expect_payment_failed!(nodes[0], events, dust_hash, true);
7251                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7252                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7253                         mine_transaction(&nodes[0], &timeout_tx[0]);
7254                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7255                         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7256                         let events = nodes[0].node.get_and_clear_pending_events();
7257                         expect_payment_failed!(nodes[0], events, non_dust_hash, true);
7258                 } else {
7259                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7260                         // commitment tx
7261                         let events = nodes[0].node.get_and_clear_pending_events();
7262                         assert_eq!(events.len(), 2);
7263                         let first;
7264                         match events[0] {
7265                                 Event::PaymentFailed { payment_hash, .. } => {
7266                                         if payment_hash == dust_hash { first = true; }
7267                                         else { first = false; }
7268                                 },
7269                                 _ => panic!("Unexpected event"),
7270                         }
7271                         match events[1] {
7272                                 Event::PaymentFailed { payment_hash, .. } => {
7273                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7274                                         else { assert_eq!(payment_hash, dust_hash); }
7275                                 },
7276                                 _ => panic!("Unexpected event"),
7277                         }
7278                 }
7279         }
7280 }
7281
7282 #[test]
7283 fn test_sweep_outbound_htlc_failure_update() {
7284         do_test_sweep_outbound_htlc_failure_update(false, true);
7285         do_test_sweep_outbound_htlc_failure_update(false, false);
7286         do_test_sweep_outbound_htlc_failure_update(true, false);
7287 }
7288
7289 #[test]
7290 fn test_user_configurable_csv_delay() {
7291         // We test our channel constructors yield errors when we pass them absurd csv delay
7292
7293         let mut low_our_to_self_config = UserConfig::default();
7294         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7295         let mut high_their_to_self_config = UserConfig::default();
7296         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7297         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7298         let chanmon_cfgs = create_chanmon_cfgs(2);
7299         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7300         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7301         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7302
7303         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7304         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(), &InitFeatures::known(), 1000000, 1000000, 0, &low_our_to_self_config) {
7305                 match error {
7306                         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())); },
7307                         _ => panic!("Unexpected event"),
7308                 }
7309         } else { assert!(false) }
7310
7311         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7312         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7313         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7314         open_channel.to_self_delay = 200;
7315         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) {
7316                 match error {
7317                         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()));  },
7318                         _ => panic!("Unexpected event"),
7319                 }
7320         } else { assert!(false); }
7321
7322         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7323         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7324         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()));
7325         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7326         accept_channel.to_self_delay = 200;
7327         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7328         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7329                 match action {
7330                         &ErrorAction::SendErrorMessage { ref msg } => {
7331                                 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()));
7332                         },
7333                         _ => { assert!(false); }
7334                 }
7335         } else { assert!(false); }
7336         check_closed_event!(nodes[0], 1);
7337
7338         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7339         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7340         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7341         open_channel.to_self_delay = 200;
7342         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) {
7343                 match error {
7344                         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())); },
7345                         _ => panic!("Unexpected event"),
7346                 }
7347         } else { assert!(false); }
7348 }
7349
7350 #[test]
7351 fn test_data_loss_protect() {
7352         // We want to be sure that :
7353         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7354         //   (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7355         // * we close channel in case of detecting other being fallen behind
7356         // * we are able to claim our own outputs thanks to to_remote being static
7357         // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7358         let persister;
7359         let logger;
7360         let fee_estimator;
7361         let tx_broadcaster;
7362         let chain_source;
7363         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7364         // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7365         // during signing due to revoked tx
7366         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7367         let keys_manager = &chanmon_cfgs[0].keys_manager;
7368         let monitor;
7369         let node_state_0;
7370         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7371         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7372         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7373
7374         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7375
7376         // Cache node A state before any channel update
7377         let previous_node_state = nodes[0].node.encode();
7378         let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7379         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7380
7381         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7382         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7383
7384         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7385         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7386
7387         // Restore node A from previous state
7388         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7389         let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7390         chain_source = test_utils::TestChainSource::new(Network::Testnet);
7391         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7392         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
7393         persister = test_utils::TestPersister::new();
7394         monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7395         node_state_0 = {
7396                 let mut channel_monitors = HashMap::new();
7397                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7398                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
7399                         keys_manager: keys_manager,
7400                         fee_estimator: &fee_estimator,
7401                         chain_monitor: &monitor,
7402                         logger: &logger,
7403                         tx_broadcaster: &tx_broadcaster,
7404                         default_config: UserConfig::default(),
7405                         channel_monitors,
7406                 }).unwrap().1
7407         };
7408         nodes[0].node = &node_state_0;
7409         assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7410         nodes[0].chain_monitor = &monitor;
7411         nodes[0].chain_source = &chain_source;
7412
7413         check_added_monitors!(nodes[0], 1);
7414
7415         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7416         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7417
7418         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7419
7420         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7421         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7422         check_added_monitors!(nodes[0], 1);
7423
7424         {
7425                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7426                 assert_eq!(node_txn.len(), 0);
7427         }
7428
7429         let mut reestablish_1 = Vec::with_capacity(1);
7430         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7431                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7432                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7433                         reestablish_1.push(msg.clone());
7434                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7435                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7436                         match action {
7437                                 &ErrorAction::SendErrorMessage { ref msg } => {
7438                                         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");
7439                                 },
7440                                 _ => panic!("Unexpected event!"),
7441                         }
7442                 } else {
7443                         panic!("Unexpected event")
7444                 }
7445         }
7446
7447         // Check we close channel detecting A is fallen-behind
7448         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7449         check_closed_event!(nodes[1], 1);
7450         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7451         check_added_monitors!(nodes[1], 1);
7452
7453         // Check A is able to claim to_remote output
7454         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7455         assert_eq!(node_txn.len(), 1);
7456         check_spends!(node_txn[0], chan.3);
7457         assert_eq!(node_txn[0].output.len(), 2);
7458         mine_transaction(&nodes[0], &node_txn[0]);
7459         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7460         check_closed_event!(nodes[0], 1);
7461         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
7462         assert_eq!(spend_txn.len(), 1);
7463         check_spends!(spend_txn[0], node_txn[0]);
7464 }
7465
7466 #[test]
7467 fn test_check_htlc_underpaying() {
7468         // Send payment through A -> B but A is maliciously
7469         // sending a probe payment (i.e less than expected value0
7470         // to B, B should refuse payment.
7471
7472         let chanmon_cfgs = create_chanmon_cfgs(2);
7473         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7474         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7475         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7476
7477         // Create some initial channels
7478         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7479
7480         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
7481         let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7482         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7483         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7484         check_added_monitors!(nodes[0], 1);
7485
7486         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7487         assert_eq!(events.len(), 1);
7488         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7489         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7490         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7491
7492         // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7493         // and then will wait a second random delay before failing the HTLC back:
7494         let events = nodes[1].node.get_and_clear_pending_events();
7495         expect_pending_htlcs_forwardable!(nodes[1], events);
7496         let events = nodes[1].node.get_and_clear_pending_events();
7497         expect_pending_htlcs_forwardable!(nodes[1], events);
7498
7499         // Node 3 is expecting payment of 100_000 but received 10_000,
7500         // it should fail htlc like we didn't know the preimage.
7501         nodes[1].node.process_pending_htlc_forwards();
7502
7503         let events = nodes[1].node.get_and_clear_pending_msg_events();
7504         assert_eq!(events.len(), 1);
7505         let (update_fail_htlc, commitment_signed) = match events[0] {
7506                 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 } } => {
7507                         assert!(update_add_htlcs.is_empty());
7508                         assert!(update_fulfill_htlcs.is_empty());
7509                         assert_eq!(update_fail_htlcs.len(), 1);
7510                         assert!(update_fail_malformed_htlcs.is_empty());
7511                         assert!(update_fee.is_none());
7512                         (update_fail_htlcs[0].clone(), commitment_signed)
7513                 },
7514                 _ => panic!("Unexpected event"),
7515         };
7516         check_added_monitors!(nodes[1], 1);
7517
7518         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7519         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7520
7521         // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7522         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7523         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7524         let events = nodes[0].node.get_and_clear_pending_events();
7525         expect_payment_failed!(nodes[0], events, our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7526 }
7527
7528 #[test]
7529 fn test_announce_disable_channels() {
7530         // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7531         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7532
7533         let chanmon_cfgs = create_chanmon_cfgs(2);
7534         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7535         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7536         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7537
7538         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7539         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7540         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7541
7542         // Disconnect peers
7543         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7544         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7545
7546         nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7547         nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7548         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7549         assert_eq!(msg_events.len(), 3);
7550         let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7551         for e in msg_events {
7552                 match e {
7553                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7554                                 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7555                                 // Check that each channel gets updated exactly once
7556                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7557                                         panic!("Generated ChannelUpdate for wrong chan!");
7558                                 }
7559                         },
7560                         _ => panic!("Unexpected event"),
7561                 }
7562         }
7563         // Reconnect peers
7564         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7565         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7566         assert_eq!(reestablish_1.len(), 3);
7567         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7568         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7569         assert_eq!(reestablish_2.len(), 3);
7570
7571         // Reestablish chan_1
7572         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7573         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7574         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7575         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7576         // Reestablish chan_2
7577         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7578         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7579         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7580         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7581         // Reestablish chan_3
7582         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7583         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7584         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7585         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7586
7587         nodes[0].node.timer_tick_occurred();
7588         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7589         nodes[0].node.timer_tick_occurred();
7590         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7591         assert_eq!(msg_events.len(), 3);
7592         chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7593         for e in msg_events {
7594                 match e {
7595                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7596                                 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7597                                 // Check that each channel gets updated exactly once
7598                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7599                                         panic!("Generated ChannelUpdate for wrong chan!");
7600                                 }
7601                         },
7602                         _ => panic!("Unexpected event"),
7603                 }
7604         }
7605 }
7606
7607 #[test]
7608 fn test_priv_forwarding_rejection() {
7609         // If we have a private channel with outbound liquidity, and
7610         // UserConfig::accept_forwards_to_priv_channels is set to false, we should reject any attempts
7611         // to forward through that channel.
7612         let chanmon_cfgs = create_chanmon_cfgs(3);
7613         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7614         let mut no_announce_cfg = test_default_channel_config();
7615         no_announce_cfg.channel_options.announced_channel = false;
7616         no_announce_cfg.accept_forwards_to_priv_channels = false;
7617         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(no_announce_cfg), None]);
7618         let persister: test_utils::TestPersister;
7619         let new_chain_monitor: test_utils::TestChainMonitor;
7620         let nodes_1_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
7621         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7622
7623         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
7624
7625         // Note that the create_*_chan functions in utils requires announcement_signatures, which we do
7626         // not send for private channels.
7627         nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
7628         let open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[2].node.get_our_node_id());
7629         nodes[2].node.handle_open_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel);
7630         let accept_channel = get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[1].node.get_our_node_id());
7631         nodes[1].node.handle_accept_channel(&nodes[2].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7632
7633         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[1], 1_000_000, 42);
7634         nodes[1].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
7635         nodes[2].node.handle_funding_created(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingCreated, nodes[2].node.get_our_node_id()));
7636         check_added_monitors!(nodes[2], 1);
7637
7638         nodes[1].node.handle_funding_signed(&nodes[2].node.get_our_node_id(), &get_event_msg!(nodes[2], MessageSendEvent::SendFundingSigned, nodes[1].node.get_our_node_id()));
7639         check_added_monitors!(nodes[1], 1);
7640
7641         let conf_height = core::cmp::max(nodes[1].best_block_info().1 + 1, nodes[2].best_block_info().1 + 1);
7642         confirm_transaction_at(&nodes[1], &tx, conf_height);
7643         connect_blocks(&nodes[1], CHAN_CONFIRM_DEPTH - 1);
7644         confirm_transaction_at(&nodes[2], &tx, conf_height);
7645         connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1);
7646         let as_funding_locked = get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[2].node.get_our_node_id());
7647         nodes[1].node.handle_funding_locked(&nodes[2].node.get_our_node_id(), &get_event_msg!(nodes[2], MessageSendEvent::SendFundingLocked, nodes[1].node.get_our_node_id()));
7648         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
7649         nodes[2].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &as_funding_locked);
7650         get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7651
7652         assert!(nodes[0].node.list_usable_channels()[0].is_public);
7653         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
7654         assert!(!nodes[2].node.list_usable_channels()[0].is_public);
7655
7656         // We should always be able to forward through nodes[1] as long as its out through a public
7657         // channel:
7658         send_payment(&nodes[2], &[&nodes[1], &nodes[0]], 10_000);
7659
7660         // ... however, if we send to nodes[2], we will have to pass the private channel from nodes[1]
7661         // to nodes[2], which should be rejected:
7662         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7663         let route = get_route(&nodes[0].node.get_our_node_id(),
7664                 &nodes[0].net_graph_msg_handler.network_graph,
7665                 &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None,
7666                 &[&RouteHint(vec![RouteHintHop {
7667                         src_node_id: nodes[1].node.get_our_node_id(),
7668                         short_channel_id: nodes[2].node.list_channels()[0].short_channel_id.unwrap(),
7669                         fees: RoutingFees { base_msat: 1000, proportional_millionths: 0 },
7670                         cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
7671                         htlc_minimum_msat: None,
7672                         htlc_maximum_msat: None,
7673                 }])], 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
7674
7675         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7676         check_added_monitors!(nodes[0], 1);
7677         let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
7678         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7679         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true);
7680
7681         let htlc_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7682         assert!(htlc_fail_updates.update_add_htlcs.is_empty());
7683         assert_eq!(htlc_fail_updates.update_fail_htlcs.len(), 1);
7684         assert!(htlc_fail_updates.update_fail_malformed_htlcs.is_empty());
7685         assert!(htlc_fail_updates.update_fee.is_none());
7686
7687         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates.update_fail_htlcs[0]);
7688         commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates.commitment_signed, true, true);
7689         expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, nodes[2].node.list_channels()[0].short_channel_id.unwrap(), true);
7690
7691         // Now disconnect nodes[1] from its peers and restart with accept_forwards_to_priv_channels set
7692         // to true. Sadly there is currently no way to change it at runtime.
7693
7694         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7695         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7696
7697         let nodes_1_serialized = nodes[1].node.encode();
7698         let mut monitor_a_serialized = test_utils::TestVecWriter(Vec::new());
7699         let mut monitor_b_serialized = test_utils::TestVecWriter(Vec::new());
7700         {
7701                 let mons = nodes[1].chain_monitor.chain_monitor.monitors.read().unwrap();
7702                 let mut mon_iter = mons.iter();
7703                 mon_iter.next().unwrap().1.write(&mut monitor_a_serialized).unwrap();
7704                 mon_iter.next().unwrap().1.write(&mut monitor_b_serialized).unwrap();
7705         }
7706
7707         persister = test_utils::TestPersister::new();
7708         let keys_manager = &chanmon_cfgs[1].keys_manager;
7709         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[1].chain_source), nodes[1].tx_broadcaster.clone(), nodes[1].logger, node_cfgs[1].fee_estimator, &persister, keys_manager);
7710         nodes[1].chain_monitor = &new_chain_monitor;
7711
7712         let mut monitor_a_read = &monitor_a_serialized.0[..];
7713         let mut monitor_b_read = &monitor_b_serialized.0[..];
7714         let (_, mut monitor_a) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_a_read, keys_manager).unwrap();
7715         let (_, mut monitor_b) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_b_read, keys_manager).unwrap();
7716         assert!(monitor_a_read.is_empty());
7717         assert!(monitor_b_read.is_empty());
7718
7719         no_announce_cfg.accept_forwards_to_priv_channels = true;
7720
7721         let mut nodes_1_read = &nodes_1_serialized[..];
7722         let (_, nodes_1_deserialized_tmp) = {
7723                 let mut channel_monitors = HashMap::new();
7724                 channel_monitors.insert(monitor_a.get_funding_txo().0, &mut monitor_a);
7725                 channel_monitors.insert(monitor_b.get_funding_txo().0, &mut monitor_b);
7726                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_1_read, ChannelManagerReadArgs {
7727                         default_config: no_announce_cfg,
7728                         keys_manager,
7729                         fee_estimator: node_cfgs[1].fee_estimator,
7730                         chain_monitor: nodes[1].chain_monitor,
7731                         tx_broadcaster: nodes[1].tx_broadcaster.clone(),
7732                         logger: nodes[1].logger,
7733                         channel_monitors,
7734                 }).unwrap()
7735         };
7736         assert!(nodes_1_read.is_empty());
7737         nodes_1_deserialized = nodes_1_deserialized_tmp;
7738
7739         assert!(nodes[1].chain_monitor.watch_channel(monitor_a.get_funding_txo().0, monitor_a).is_ok());
7740         assert!(nodes[1].chain_monitor.watch_channel(monitor_b.get_funding_txo().0, monitor_b).is_ok());
7741         check_added_monitors!(nodes[1], 2);
7742         nodes[1].node = &nodes_1_deserialized;
7743
7744         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
7745         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7746         let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
7747         let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
7748         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
7749         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
7750         get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7751         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
7752
7753         nodes[1].node.peer_connected(&nodes[2].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
7754         nodes[2].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7755         let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[2].node.get_our_node_id());
7756         let cs_reestablish = get_event_msg!(nodes[2], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
7757         nodes[2].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
7758         nodes[1].node.handle_channel_reestablish(&nodes[2].node.get_our_node_id(), &cs_reestablish);
7759         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
7760         get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7761
7762         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7763         check_added_monitors!(nodes[0], 1);
7764         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 10_000, our_payment_hash, our_payment_secret);
7765         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], our_payment_preimage);
7766 }
7767
7768 #[test]
7769 fn test_bump_penalty_txn_on_revoked_commitment() {
7770         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7771         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7772
7773         let chanmon_cfgs = create_chanmon_cfgs(2);
7774         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7775         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7776         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7777
7778         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7779         let logger = test_utils::TestLogger::new();
7780
7781         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7782         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7783         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3000000, 30, &logger).unwrap();
7784         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7785
7786         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7787         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7788         assert_eq!(revoked_txn[0].output.len(), 4);
7789         assert_eq!(revoked_txn[0].input.len(), 1);
7790         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7791         let revoked_txid = revoked_txn[0].txid();
7792
7793         let mut penalty_sum = 0;
7794         for outp in revoked_txn[0].output.iter() {
7795                 if outp.script_pubkey.is_v0_p2wsh() {
7796                         penalty_sum += outp.value;
7797                 }
7798         }
7799
7800         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7801         let header_114 = connect_blocks(&nodes[1], 14);
7802
7803         // Actually revoke tx by claiming a HTLC
7804         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7805         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7806         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7807         check_added_monitors!(nodes[1], 1);
7808
7809         // One or more justice tx should have been broadcast, check it
7810         let penalty_1;
7811         let feerate_1;
7812         {
7813                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7814                 assert_eq!(node_txn.len(), 2); // justice tx (broadcasted from ChannelMonitor) + local commitment tx
7815                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7816                 assert_eq!(node_txn[0].output.len(), 1);
7817                 check_spends!(node_txn[0], revoked_txn[0]);
7818                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7819                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7820                 penalty_1 = node_txn[0].txid();
7821                 node_txn.clear();
7822         };
7823
7824         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7825         connect_blocks(&nodes[1], 15);
7826         let mut penalty_2 = penalty_1;
7827         let mut feerate_2 = 0;
7828         {
7829                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7830                 assert_eq!(node_txn.len(), 1);
7831                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7832                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7833                         assert_eq!(node_txn[0].output.len(), 1);
7834                         check_spends!(node_txn[0], revoked_txn[0]);
7835                         penalty_2 = node_txn[0].txid();
7836                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7837                         assert_ne!(penalty_2, penalty_1);
7838                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7839                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7840                         // Verify 25% bump heuristic
7841                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7842                         node_txn.clear();
7843                 }
7844         }
7845         assert_ne!(feerate_2, 0);
7846
7847         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7848         connect_blocks(&nodes[1], 1);
7849         let penalty_3;
7850         let mut feerate_3 = 0;
7851         {
7852                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7853                 assert_eq!(node_txn.len(), 1);
7854                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7855                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7856                         assert_eq!(node_txn[0].output.len(), 1);
7857                         check_spends!(node_txn[0], revoked_txn[0]);
7858                         penalty_3 = node_txn[0].txid();
7859                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7860                         assert_ne!(penalty_3, penalty_2);
7861                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7862                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7863                         // Verify 25% bump heuristic
7864                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7865                         node_txn.clear();
7866                 }
7867         }
7868         assert_ne!(feerate_3, 0);
7869
7870         nodes[1].node.get_and_clear_pending_events();
7871         nodes[1].node.get_and_clear_pending_msg_events();
7872 }
7873
7874 #[test]
7875 fn test_bump_penalty_txn_on_revoked_htlcs() {
7876         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7877         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7878
7879         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7880         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
7881         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7882         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7883         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7884
7885         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7886         // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
7887         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph,
7888                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
7889         let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
7890         let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph,
7891                 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
7892         send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
7893
7894         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7895         assert_eq!(revoked_local_txn[0].input.len(), 1);
7896         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7897
7898         // Revoke local commitment tx
7899         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7900
7901         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7902         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7903         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
7904         check_closed_broadcast!(nodes[1], true);
7905         check_added_monitors!(nodes[1], 1);
7906         check_closed_event!(nodes[1], 1);
7907         connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
7908
7909         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7910         assert_eq!(revoked_htlc_txn.len(), 3);
7911         check_spends!(revoked_htlc_txn[1], chan.3);
7912
7913         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7914         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7915         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7916
7917         assert_eq!(revoked_htlc_txn[2].input.len(), 1);
7918         assert_eq!(revoked_htlc_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7919         assert_eq!(revoked_htlc_txn[2].output.len(), 1);
7920         check_spends!(revoked_htlc_txn[2], revoked_local_txn[0]);
7921
7922         // Broadcast set of revoked txn on A
7923         let hash_128 = connect_blocks(&nodes[0], 40);
7924         let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7925         connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
7926         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7927         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[2].clone()] });
7928         let events = nodes[0].node.get_and_clear_pending_events();
7929         expect_pending_htlcs_forwardable_ignore!(nodes[0], events[0..1]);
7930         match events[1] {
7931                 Event::ChannelClosed { .. } => {}
7932                 _ => panic!("Unexpected event"),
7933         }
7934         let first;
7935         let feerate_1;
7936         let penalty_txn;
7937         {
7938                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7939                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7940                 // Verify claim tx are spending revoked HTLC txn
7941
7942                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
7943                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
7944                 // which are included in the same block (they are broadcasted because we scan the
7945                 // transactions linearly and generate claims as we go, they likely should be removed in the
7946                 // future).
7947                 assert_eq!(node_txn[0].input.len(), 1);
7948                 check_spends!(node_txn[0], revoked_local_txn[0]);
7949                 assert_eq!(node_txn[1].input.len(), 1);
7950                 check_spends!(node_txn[1], revoked_local_txn[0]);
7951                 assert_eq!(node_txn[2].input.len(), 1);
7952                 check_spends!(node_txn[2], revoked_local_txn[0]);
7953
7954                 // Each of the three justice transactions claim a separate (single) output of the three
7955                 // available, which we check here:
7956                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
7957                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
7958                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
7959
7960                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7961                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
7962
7963                 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
7964                 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
7965                 // a remote commitment tx has already been confirmed).
7966                 check_spends!(node_txn[3], chan.3);
7967
7968                 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
7969                 // output, checked above).
7970                 assert_eq!(node_txn[4].input.len(), 2);
7971                 assert_eq!(node_txn[4].output.len(), 1);
7972                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[2]);
7973
7974                 first = node_txn[4].txid();
7975                 // Store both feerates for later comparison
7976                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[4].output[0].value;
7977                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7978                 penalty_txn = vec![node_txn[2].clone()];
7979                 node_txn.clear();
7980         }
7981
7982         // Connect one more block to see if bumped penalty are issued for HTLC txn
7983         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7984         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
7985         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7986         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
7987         {
7988                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7989                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7990
7991                 check_spends!(node_txn[0], revoked_local_txn[0]);
7992                 check_spends!(node_txn[1], revoked_local_txn[0]);
7993                 // Note that these are both bogus - they spend outputs already claimed in block 129:
7994                 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output  {
7995                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
7996                 } else {
7997                         assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
7998                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7999                 }
8000
8001                 node_txn.clear();
8002         };
8003
8004         // Few more blocks to confirm penalty txn
8005         connect_blocks(&nodes[0], 4);
8006         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8007         let header_144 = connect_blocks(&nodes[0], 9);
8008         let node_txn = {
8009                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8010                 assert_eq!(node_txn.len(), 1);
8011
8012                 assert_eq!(node_txn[0].input.len(), 2);
8013                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8014                 // Verify bumped tx is different and 25% bump heuristic
8015                 assert_ne!(first, node_txn[0].txid());
8016                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[0].output[0].value;
8017                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8018                 assert!(feerate_2 * 100 > feerate_1 * 125);
8019                 let txn = vec![node_txn[0].clone()];
8020                 node_txn.clear();
8021                 txn
8022         };
8023         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8024         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8025         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
8026         connect_blocks(&nodes[0], 20);
8027         {
8028                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8029                 // We verify than no new transaction has been broadcast because previously
8030                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8031                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8032                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8033                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8034                 // up bumped justice generation.
8035                 assert_eq!(node_txn.len(), 0);
8036                 node_txn.clear();
8037         }
8038         check_closed_broadcast!(nodes[0], true);
8039         check_added_monitors!(nodes[0], 1);
8040 }
8041
8042 #[test]
8043 fn test_bump_penalty_txn_on_remote_commitment() {
8044         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8045         // we're able to claim outputs on remote commitment transaction before timelocks expiration
8046
8047         // Create 2 HTLCs
8048         // Provide preimage for one
8049         // Check aggregation
8050
8051         let chanmon_cfgs = create_chanmon_cfgs(2);
8052         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8053         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8054         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8055
8056         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8057         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8058         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8059
8060         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8061         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8062         assert_eq!(remote_txn[0].output.len(), 4);
8063         assert_eq!(remote_txn[0].input.len(), 1);
8064         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8065
8066         // Claim a HTLC without revocation (provide B monitor with preimage)
8067         nodes[1].node.claim_funds(payment_preimage);
8068         mine_transaction(&nodes[1], &remote_txn[0]);
8069         check_added_monitors!(nodes[1], 2);
8070         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
8071
8072         // One or more claim tx should have been broadcast, check it
8073         let timeout;
8074         let preimage;
8075         let preimage_bump;
8076         let feerate_timeout;
8077         let feerate_preimage;
8078         {
8079                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8080                 // 9 transactions including:
8081                 // 1*2 ChannelManager local broadcasts of commitment + HTLC-Success
8082                 // 1*3 ChannelManager local broadcasts of commitment + HTLC-Success + HTLC-Timeout
8083                 // 2 * HTLC-Success (one RBF bump we'll check later)
8084                 // 1 * HTLC-Timeout
8085                 assert_eq!(node_txn.len(), 8);
8086                 assert_eq!(node_txn[0].input.len(), 1);
8087                 assert_eq!(node_txn[6].input.len(), 1);
8088                 check_spends!(node_txn[0], remote_txn[0]);
8089                 check_spends!(node_txn[6], remote_txn[0]);
8090                 assert_eq!(node_txn[0].input[0].previous_output, node_txn[3].input[0].previous_output);
8091                 preimage_bump = node_txn[3].clone();
8092
8093                 check_spends!(node_txn[1], chan.3);
8094                 check_spends!(node_txn[2], node_txn[1]);
8095                 assert_eq!(node_txn[1], node_txn[4]);
8096                 assert_eq!(node_txn[2], node_txn[5]);
8097
8098                 timeout = node_txn[6].txid();
8099                 let index = node_txn[6].input[0].previous_output.vout;
8100                 let fee = remote_txn[0].output[index as usize].value - node_txn[6].output[0].value;
8101                 feerate_timeout = fee * 1000 / node_txn[6].get_weight() as u64;
8102
8103                 preimage = node_txn[0].txid();
8104                 let index = node_txn[0].input[0].previous_output.vout;
8105                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8106                 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8107
8108                 node_txn.clear();
8109         };
8110         assert_ne!(feerate_timeout, 0);
8111         assert_ne!(feerate_preimage, 0);
8112
8113         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8114         connect_blocks(&nodes[1], 15);
8115         {
8116                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8117                 assert_eq!(node_txn.len(), 1);
8118                 assert_eq!(node_txn[0].input.len(), 1);
8119                 assert_eq!(preimage_bump.input.len(), 1);
8120                 check_spends!(node_txn[0], remote_txn[0]);
8121                 check_spends!(preimage_bump, remote_txn[0]);
8122
8123                 let index = preimage_bump.input[0].previous_output.vout;
8124                 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
8125                 let new_feerate = fee * 1000 / preimage_bump.get_weight() as u64;
8126                 assert!(new_feerate * 100 > feerate_timeout * 125);
8127                 assert_ne!(timeout, preimage_bump.txid());
8128
8129                 let index = node_txn[0].input[0].previous_output.vout;
8130                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8131                 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8132                 assert!(new_feerate * 100 > feerate_preimage * 125);
8133                 assert_ne!(preimage, node_txn[0].txid());
8134
8135                 node_txn.clear();
8136         }
8137
8138         nodes[1].node.get_and_clear_pending_events();
8139         nodes[1].node.get_and_clear_pending_msg_events();
8140 }
8141
8142 #[test]
8143 fn test_counterparty_raa_skip_no_crash() {
8144         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8145         // commitment transaction, we would have happily carried on and provided them the next
8146         // commitment transaction based on one RAA forward. This would probably eventually have led to
8147         // channel closure, but it would not have resulted in funds loss. Still, our
8148         // EnforcingSigner would have panicked as it doesn't like jumps into the future. Here, we
8149         // check simply that the channel is closed in response to such an RAA, but don't check whether
8150         // we decide to punish our counterparty for revoking their funds (as we don't currently
8151         // implement that).
8152         let chanmon_cfgs = create_chanmon_cfgs(2);
8153         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8154         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8155         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8156         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8157
8158         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8159         let keys = guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8160
8161         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8162
8163         // Make signer believe we got a counterparty signature, so that it allows the revocation
8164         keys.get_enforcement_state().last_holder_commitment -= 1;
8165         let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8166
8167         // Must revoke without gaps
8168         keys.get_enforcement_state().last_holder_commitment -= 1;
8169         keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8170
8171         keys.get_enforcement_state().last_holder_commitment -= 1;
8172         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8173                 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8174
8175         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8176                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8177         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8178         check_added_monitors!(nodes[1], 1);
8179         check_closed_event!(nodes[1], 1);
8180 }
8181
8182 #[test]
8183 fn test_bump_txn_sanitize_tracking_maps() {
8184         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8185         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8186
8187         let chanmon_cfgs = create_chanmon_cfgs(2);
8188         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8189         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8190         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8191
8192         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8193         // Lock HTLC in both directions
8194         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8195         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8196
8197         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8198         assert_eq!(revoked_local_txn[0].input.len(), 1);
8199         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8200
8201         // Revoke local commitment tx
8202         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8203
8204         // Broadcast set of revoked txn on A
8205         connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8206         let events = nodes[0].node.get_and_clear_pending_events();
8207         expect_pending_htlcs_forwardable_ignore!(nodes[0], events);
8208         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8209
8210         mine_transaction(&nodes[0], &revoked_local_txn[0]);
8211         check_closed_broadcast!(nodes[0], true);
8212         check_added_monitors!(nodes[0], 1);
8213         check_closed_event!(nodes[0], 1);
8214         let penalty_txn = {
8215                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8216                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8217                 check_spends!(node_txn[0], revoked_local_txn[0]);
8218                 check_spends!(node_txn[1], revoked_local_txn[0]);
8219                 check_spends!(node_txn[2], revoked_local_txn[0]);
8220                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8221                 node_txn.clear();
8222                 penalty_txn
8223         };
8224         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8225         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8226         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8227         {
8228                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8229                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8230                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8231                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8232                 }
8233         }
8234 }
8235
8236 #[test]
8237 fn test_override_channel_config() {
8238         let chanmon_cfgs = create_chanmon_cfgs(2);
8239         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8240         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8241         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8242
8243         // Node0 initiates a channel to node1 using the override config.
8244         let mut override_config = UserConfig::default();
8245         override_config.own_channel_config.our_to_self_delay = 200;
8246
8247         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8248
8249         // Assert the channel created by node0 is using the override config.
8250         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8251         assert_eq!(res.channel_flags, 0);
8252         assert_eq!(res.to_self_delay, 200);
8253 }
8254
8255 #[test]
8256 fn test_override_0msat_htlc_minimum() {
8257         let mut zero_config = UserConfig::default();
8258         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8259         let chanmon_cfgs = create_chanmon_cfgs(2);
8260         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8261         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8262         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8263
8264         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8265         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8266         assert_eq!(res.htlc_minimum_msat, 1);
8267
8268         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8269         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8270         assert_eq!(res.htlc_minimum_msat, 1);
8271 }
8272
8273 #[test]
8274 fn test_simple_mpp() {
8275         // Simple test of sending a multi-path payment.
8276         let chanmon_cfgs = create_chanmon_cfgs(4);
8277         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8278         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8279         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8280
8281         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8282         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8283         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8284         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8285         let logger = test_utils::TestLogger::new();
8286
8287         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8288         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8289         let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8290         let path = route.paths[0].clone();
8291         route.paths.push(path);
8292         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8293         route.paths[0][0].short_channel_id = chan_1_id;
8294         route.paths[0][1].short_channel_id = chan_3_id;
8295         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8296         route.paths[1][0].short_channel_id = chan_2_id;
8297         route.paths[1][1].short_channel_id = chan_4_id;
8298         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8299         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8300 }
8301
8302 #[test]
8303 fn test_preimage_storage() {
8304         // Simple test of payment preimage storage allowing no client-side storage to claim payments
8305         let chanmon_cfgs = create_chanmon_cfgs(2);
8306         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8307         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8308         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8309
8310         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8311
8312         {
8313                 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8314
8315                 let logger = test_utils::TestLogger::new();
8316                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8317                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8318                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8319                 check_added_monitors!(nodes[0], 1);
8320                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8321                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8322                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8323                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8324         }
8325         // Note that after leaving the above scope we have no knowledge of any arguments or return
8326         // values from previous calls.
8327         let events = nodes[1].node.get_and_clear_pending_events();
8328         expect_pending_htlcs_forwardable!(nodes[1], events);
8329         let events = nodes[1].node.get_and_clear_pending_events();
8330         assert_eq!(events.len(), 1);
8331         match events[0] {
8332                 Event::PaymentReceived { ref purpose, .. } => {
8333                         match &purpose {
8334                                 PaymentPurpose::InvoicePayment { payment_preimage, user_payment_id, .. } => {
8335                                         assert_eq!(*user_payment_id, 42);
8336                                         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8337                                 },
8338                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
8339                         }
8340                 },
8341                 _ => panic!("Unexpected event"),
8342         }
8343 }
8344
8345 #[test]
8346 fn test_secret_timeout() {
8347         // Simple test of payment secret storage time outs
8348         let chanmon_cfgs = create_chanmon_cfgs(2);
8349         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8350         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8351         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8352
8353         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8354
8355         let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8356
8357         // We should fail to register the same payment hash twice, at least until we've connected a
8358         // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8359         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8360                 assert_eq!(err, "Duplicate payment hash");
8361         } else { panic!(); }
8362         let mut block = {
8363                 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8364                 Block {
8365                         header: BlockHeader {
8366                                 version: 0x2000000,
8367                                 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8368                                 merkle_root: Default::default(),
8369                                 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8370                         txdata: vec![],
8371                 }
8372         };
8373         connect_block(&nodes[1], &block);
8374         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8375                 assert_eq!(err, "Duplicate payment hash");
8376         } else { panic!(); }
8377
8378         // If we then connect the second block, we should be able to register the same payment hash
8379         // again with a different user_payment_id (this time getting a new payment secret).
8380         block.header.prev_blockhash = block.header.block_hash();
8381         block.header.time += 1;
8382         connect_block(&nodes[1], &block);
8383         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8384         assert_ne!(payment_secret_1, our_payment_secret);
8385
8386         {
8387                 let logger = test_utils::TestLogger::new();
8388                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8389                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8390                 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8391                 check_added_monitors!(nodes[0], 1);
8392                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8393                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8394                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8395                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8396         }
8397         // Note that after leaving the above scope we have no knowledge of any arguments or return
8398         // values from previous calls.
8399         let events = nodes[1].node.get_and_clear_pending_events();
8400         expect_pending_htlcs_forwardable!(nodes[1], events);
8401         let events = nodes[1].node.get_and_clear_pending_events();
8402         assert_eq!(events.len(), 1);
8403         match events[0] {
8404                 Event::PaymentReceived { purpose: PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, user_payment_id }, .. } => {
8405                         assert!(payment_preimage.is_none());
8406                         assert_eq!(user_payment_id, 42);
8407                         assert_eq!(payment_secret, our_payment_secret);
8408                         // We don't actually have the payment preimage with which to claim this payment!
8409                 },
8410                 _ => panic!("Unexpected event"),
8411         }
8412 }
8413
8414 #[test]
8415 fn test_bad_secret_hash() {
8416         // Simple test of unregistered payment hash/invalid payment secret handling
8417         let chanmon_cfgs = create_chanmon_cfgs(2);
8418         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8419         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8420         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8421
8422         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8423
8424         let random_payment_hash = PaymentHash([42; 32]);
8425         let random_payment_secret = PaymentSecret([43; 32]);
8426         let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8427
8428         let logger = test_utils::TestLogger::new();
8429         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8430         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8431
8432         // All the below cases should end up being handled exactly identically, so we macro the
8433         // resulting events.
8434         macro_rules! handle_unknown_invalid_payment_data {
8435                 () => {
8436                         check_added_monitors!(nodes[0], 1);
8437                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8438                         let payment_event = SendEvent::from_event(events.pop().unwrap());
8439                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8440                         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8441
8442                         // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8443                         // again to process the pending backwards-failure of the HTLC
8444                         let events = nodes[1].node.get_and_clear_pending_events();
8445                         expect_pending_htlcs_forwardable!(nodes[1], events);
8446                         let events = nodes[1].node.get_and_clear_pending_events();
8447                         expect_pending_htlcs_forwardable!(nodes[1], events);
8448                         check_added_monitors!(nodes[1], 1);
8449
8450                         // We should fail the payment back
8451                         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8452                         match events.pop().unwrap() {
8453                                 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8454                                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8455                                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8456                                 },
8457                                 _ => panic!("Unexpected event"),
8458                         }
8459                 }
8460         }
8461
8462         let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8463         // Error data is the HTLC value (100,000) and current block height
8464         let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8465
8466         // Send a payment with the right payment hash but the wrong payment secret
8467         nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8468         handle_unknown_invalid_payment_data!();
8469         let events = nodes[0].node.get_and_clear_pending_events();
8470         expect_payment_failed!(nodes[0], events, our_payment_hash, true, expected_error_code, expected_error_data);
8471
8472         // Send a payment with a random payment hash, but the right payment secret
8473         nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8474         handle_unknown_invalid_payment_data!();
8475         let events = nodes[0].node.get_and_clear_pending_events();
8476         expect_payment_failed!(nodes[0], events, random_payment_hash, true, expected_error_code, expected_error_data);
8477
8478         // Send a payment with a random payment hash and random payment secret
8479         nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8480         handle_unknown_invalid_payment_data!();
8481         let events = nodes[0].node.get_and_clear_pending_events();
8482         expect_payment_failed!(nodes[0], events, random_payment_hash, true, expected_error_code, expected_error_data);
8483 }
8484
8485 #[test]
8486 fn test_update_err_monitor_lockdown() {
8487         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8488         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8489         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8490         //
8491         // This scenario may happen in a watchtower setup, where watchtower process a block height
8492         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8493         // commitment at same time.
8494
8495         let chanmon_cfgs = create_chanmon_cfgs(2);
8496         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8497         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8498         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8499
8500         // Create some initial channel
8501         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8502         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8503
8504         // Rebalance the network to generate htlc in the two directions
8505         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8506
8507         // Route a HTLC from node 0 to node 1 (but don't settle)
8508         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8509
8510         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8511         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8512         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8513         let persister = test_utils::TestPersister::new();
8514         let watchtower = {
8515                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8516                 let monitor = monitors.get(&outpoint).unwrap();
8517                 let mut w = test_utils::TestVecWriter(Vec::new());
8518                 monitor.write(&mut w).unwrap();
8519                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8520                                 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8521                 assert!(new_monitor == *monitor);
8522                 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);
8523                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8524                 watchtower
8525         };
8526         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8527         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8528         // transaction lock time requirements here.
8529         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (header, 0));
8530         watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8531
8532         // Try to update ChannelMonitor
8533         assert!(nodes[1].node.claim_funds(preimage));
8534         check_added_monitors!(nodes[1], 1);
8535         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8536         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8537         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8538         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8539                 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8540                         if let Err(_) =  watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8541                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8542                 } else { assert!(false); }
8543         } else { assert!(false); };
8544         // Our local monitor is in-sync and hasn't processed yet timeout
8545         check_added_monitors!(nodes[0], 1);
8546         let events = nodes[0].node.get_and_clear_pending_events();
8547         assert_eq!(events.len(), 1);
8548 }
8549
8550 #[test]
8551 fn test_concurrent_monitor_claim() {
8552         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8553         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8554         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8555         // state N+1 confirms. Alice claims output from state N+1.
8556
8557         let chanmon_cfgs = create_chanmon_cfgs(2);
8558         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8559         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8560         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8561
8562         // Create some initial channel
8563         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8564         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8565
8566         // Rebalance the network to generate htlc in the two directions
8567         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8568
8569         // Route a HTLC from node 0 to node 1 (but don't settle)
8570         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8571
8572         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8573         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8574         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8575         let persister = test_utils::TestPersister::new();
8576         let watchtower_alice = {
8577                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8578                 let monitor = monitors.get(&outpoint).unwrap();
8579                 let mut w = test_utils::TestVecWriter(Vec::new());
8580                 monitor.write(&mut w).unwrap();
8581                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8582                                 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8583                 assert!(new_monitor == *monitor);
8584                 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);
8585                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8586                 watchtower
8587         };
8588         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8589         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8590         // transaction lock time requirements here.
8591         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (header, 0));
8592         watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8593
8594         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8595         {
8596                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8597                 assert_eq!(txn.len(), 2);
8598                 txn.clear();
8599         }
8600
8601         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8602         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8603         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8604         let persister = test_utils::TestPersister::new();
8605         let watchtower_bob = {
8606                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8607                 let monitor = monitors.get(&outpoint).unwrap();
8608                 let mut w = test_utils::TestVecWriter(Vec::new());
8609                 monitor.write(&mut w).unwrap();
8610                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8611                                 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8612                 assert!(new_monitor == *monitor);
8613                 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);
8614                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8615                 watchtower
8616         };
8617         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8618         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8619
8620         // Route another payment to generate another update with still previous HTLC pending
8621         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8622         {
8623                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8624                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3000000 , TEST_FINAL_CLTV, &logger).unwrap();
8625                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8626         }
8627         check_added_monitors!(nodes[1], 1);
8628
8629         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8630         assert_eq!(updates.update_add_htlcs.len(), 1);
8631         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8632         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8633                 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8634                         // Watchtower Alice should already have seen the block and reject the update
8635                         if let Err(_) =  watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8636                         if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8637                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8638                 } else { assert!(false); }
8639         } else { assert!(false); };
8640         // Our local monitor is in-sync and hasn't processed yet timeout
8641         check_added_monitors!(nodes[0], 1);
8642
8643         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8644         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8645         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8646
8647         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8648         let bob_state_y;
8649         {
8650                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8651                 assert_eq!(txn.len(), 2);
8652                 bob_state_y = txn[0].clone();
8653                 txn.clear();
8654         };
8655
8656         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8657         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8658         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);
8659         {
8660                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8661                 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8662                 // the onchain detection of the HTLC output
8663                 assert_eq!(htlc_txn.len(), 2);
8664                 check_spends!(htlc_txn[0], bob_state_y);
8665                 check_spends!(htlc_txn[1], bob_state_y);
8666         }
8667 }
8668
8669 #[test]
8670 fn test_pre_lockin_no_chan_closed_update() {
8671         // Test that if a peer closes a channel in response to a funding_created message we don't
8672         // generate a channel update (as the channel cannot appear on chain without a funding_signed
8673         // message).
8674         //
8675         // Doing so would imply a channel monitor update before the initial channel monitor
8676         // registration, violating our API guarantees.
8677         //
8678         // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8679         // then opening a second channel with the same funding output as the first (which is not
8680         // rejected because the first channel does not exist in the ChannelManager) and closing it
8681         // before receiving funding_signed.
8682         let chanmon_cfgs = create_chanmon_cfgs(2);
8683         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8684         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8685         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8686
8687         // Create an initial channel
8688         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8689         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8690         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8691         let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8692         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8693
8694         // Move the first channel through the funding flow...
8695         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8696
8697         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8698         check_added_monitors!(nodes[0], 0);
8699
8700         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8701         let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8702         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8703         assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8704         check_closed_event!(nodes[0], 1);
8705 }
8706
8707 #[test]
8708 fn test_htlc_no_detection() {
8709         // This test is a mutation to underscore the detection logic bug we had
8710         // before #653. HTLC value routed is above the remaining balance, thus
8711         // inverting HTLC and `to_remote` output. HTLC will come second and
8712         // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8713         // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8714         // outputs order detection for correct spending children filtring.
8715
8716         let chanmon_cfgs = create_chanmon_cfgs(2);
8717         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8718         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8719         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8720
8721         // Create some initial channels
8722         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8723
8724         send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8725         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8726         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8727         assert_eq!(local_txn[0].input.len(), 1);
8728         assert_eq!(local_txn[0].output.len(), 3);
8729         check_spends!(local_txn[0], chan_1.3);
8730
8731         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8732         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8733         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8734         // We deliberately connect the local tx twice as this should provoke a failure calling
8735         // this test before #653 fix.
8736         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);
8737         check_closed_broadcast!(nodes[0], true);
8738         check_added_monitors!(nodes[0], 1);
8739         check_closed_event!(nodes[0], 1);
8740         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
8741
8742         let htlc_timeout = {
8743                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8744                 assert_eq!(node_txn[1].input.len(), 1);
8745                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8746                 check_spends!(node_txn[1], local_txn[0]);
8747                 node_txn[1].clone()
8748         };
8749
8750         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8751         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8752         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8753         let events = nodes[0].node.get_and_clear_pending_events();
8754         expect_payment_failed!(nodes[0], events, our_payment_hash, true);
8755 }
8756
8757 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8758         // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8759         // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8760         // Carol, Alice would be the upstream node, and Carol the downstream.)
8761         //
8762         // Steps of the test:
8763         // 1) Alice sends a HTLC to Carol through Bob.
8764         // 2) Carol doesn't settle the HTLC.
8765         // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8766         // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8767         // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8768         //    but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8769         // 5) Carol release the preimage to Bob off-chain.
8770         // 6) Bob claims the offered output on the broadcasted commitment.
8771         let chanmon_cfgs = create_chanmon_cfgs(3);
8772         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8773         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8774         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8775
8776         // Create some initial channels
8777         let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8778         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8779
8780         // Steps (1) and (2):
8781         // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8782         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8783
8784         // Check that Alice's commitment transaction now contains an output for this HTLC.
8785         let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8786         check_spends!(alice_txn[0], chan_ab.3);
8787         assert_eq!(alice_txn[0].output.len(), 2);
8788         check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8789         assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8790         assert_eq!(alice_txn.len(), 2);
8791
8792         // Steps (3) and (4):
8793         // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8794         // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8795         let mut force_closing_node = 0; // Alice force-closes
8796         if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8797         nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8798         check_closed_broadcast!(nodes[force_closing_node], true);
8799         check_added_monitors!(nodes[force_closing_node], 1);
8800         check_closed_event!(nodes[force_closing_node], 1);
8801         if go_onchain_before_fulfill {
8802                 let txn_to_broadcast = match broadcast_alice {
8803                         true => alice_txn.clone(),
8804                         false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8805                 };
8806                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8807                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8808                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8809                 if broadcast_alice {
8810                         check_closed_broadcast!(nodes[1], true);
8811                         check_added_monitors!(nodes[1], 1);
8812                         check_closed_event!(nodes[1], 1);
8813                 }
8814                 assert_eq!(bob_txn.len(), 1);
8815                 check_spends!(bob_txn[0], chan_ab.3);
8816         }
8817
8818         // Step (5):
8819         // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8820         // process of removing the HTLC from their commitment transactions.
8821         assert!(nodes[2].node.claim_funds(payment_preimage));
8822         check_added_monitors!(nodes[2], 1);
8823         let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8824         assert!(carol_updates.update_add_htlcs.is_empty());
8825         assert!(carol_updates.update_fail_htlcs.is_empty());
8826         assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8827         assert!(carol_updates.update_fee.is_none());
8828         assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8829
8830         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8831         expect_payment_forwarded!(nodes[1], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
8832         // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8833         if !go_onchain_before_fulfill && broadcast_alice {
8834                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8835                 assert_eq!(events.len(), 1);
8836                 match events[0] {
8837                         MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8838                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8839                         },
8840                         _ => panic!("Unexpected event"),
8841                 };
8842         }
8843         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8844         // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8845         // Carol<->Bob's updated commitment transaction info.
8846         check_added_monitors!(nodes[1], 2);
8847
8848         let events = nodes[1].node.get_and_clear_pending_msg_events();
8849         assert_eq!(events.len(), 2);
8850         let bob_revocation = match events[0] {
8851                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8852                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8853                         (*msg).clone()
8854                 },
8855                 _ => panic!("Unexpected event"),
8856         };
8857         let bob_updates = match events[1] {
8858                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8859                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8860                         (*updates).clone()
8861                 },
8862                 _ => panic!("Unexpected event"),
8863         };
8864
8865         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8866         check_added_monitors!(nodes[2], 1);
8867         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8868         check_added_monitors!(nodes[2], 1);
8869
8870         let events = nodes[2].node.get_and_clear_pending_msg_events();
8871         assert_eq!(events.len(), 1);
8872         let carol_revocation = match events[0] {
8873                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8874                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8875                         (*msg).clone()
8876                 },
8877                 _ => panic!("Unexpected event"),
8878         };
8879         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8880         check_added_monitors!(nodes[1], 1);
8881
8882         // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8883         // here's where we put said channel's commitment tx on-chain.
8884         let mut txn_to_broadcast = alice_txn.clone();
8885         if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8886         if !go_onchain_before_fulfill {
8887                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8888                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8889                 // If Bob was the one to force-close, he will have already passed these checks earlier.
8890                 if broadcast_alice {
8891                         check_closed_broadcast!(nodes[1], true);
8892                         check_added_monitors!(nodes[1], 1);
8893                         check_closed_event!(nodes[1], 1);
8894                 }
8895                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8896                 if broadcast_alice {
8897                         // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8898                         // new block being connected. The ChannelManager being notified triggers a monitor update,
8899                         // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8900                         // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8901                         // broadcasted.
8902                         assert_eq!(bob_txn.len(), 3);
8903                         check_spends!(bob_txn[1], chan_ab.3);
8904                 } else {
8905                         assert_eq!(bob_txn.len(), 2);
8906                         check_spends!(bob_txn[0], chan_ab.3);
8907                 }
8908         }
8909
8910         // Step (6):
8911         // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8912         // broadcasted commitment transaction.
8913         {
8914                 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8915                 if go_onchain_before_fulfill {
8916                         // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
8917                         assert_eq!(bob_txn.len(), 2);
8918                 }
8919                 let script_weight = match broadcast_alice {
8920                         true => OFFERED_HTLC_SCRIPT_WEIGHT,
8921                         false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8922                 };
8923                 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
8924                 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
8925                 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
8926                 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
8927                 if broadcast_alice && !go_onchain_before_fulfill {
8928                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
8929                         assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
8930                 } else {
8931                         check_spends!(bob_txn[1], txn_to_broadcast[0]);
8932                         assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
8933                 }
8934         }
8935 }
8936
8937 #[test]
8938 fn test_onchain_htlc_settlement_after_close() {
8939         do_test_onchain_htlc_settlement_after_close(true, true);
8940         do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
8941         do_test_onchain_htlc_settlement_after_close(true, false);
8942         do_test_onchain_htlc_settlement_after_close(false, false);
8943 }
8944
8945 #[test]
8946 fn test_duplicate_chan_id() {
8947         // Test that if a given peer tries to open a channel with the same channel_id as one that is
8948         // already open we reject it and keep the old channel.
8949         //
8950         // Previously, full_stack_target managed to figure out that if you tried to open two channels
8951         // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
8952         // the existing channel when we detect the duplicate new channel, screwing up our monitor
8953         // updating logic for the existing channel.
8954         let chanmon_cfgs = create_chanmon_cfgs(2);
8955         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8956         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8957         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8958
8959         // Create an initial channel
8960         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8961         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8962         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8963         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()));
8964
8965         // Try to create a second channel with the same temporary_channel_id as the first and check
8966         // that it is rejected.
8967         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8968         {
8969                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8970                 assert_eq!(events.len(), 1);
8971                 match events[0] {
8972                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8973                                 // Technically, at this point, nodes[1] would be justified in thinking both the
8974                                 // first (valid) and second (invalid) channels are closed, given they both have
8975                                 // the same non-temporary channel_id. However, currently we do not, so we just
8976                                 // move forward with it.
8977                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8978                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8979                         },
8980                         _ => panic!("Unexpected event"),
8981                 }
8982         }
8983
8984         // Move the first channel through the funding flow...
8985         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
8986
8987         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8988         check_added_monitors!(nodes[0], 0);
8989
8990         let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8991         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8992         {
8993                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
8994                 assert_eq!(added_monitors.len(), 1);
8995                 assert_eq!(added_monitors[0].0, funding_output);
8996                 added_monitors.clear();
8997         }
8998         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8999
9000         let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
9001         let channel_id = funding_outpoint.to_channel_id();
9002
9003         // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
9004         // temporary one).
9005
9006         // First try to open a second channel with a temporary channel id equal to the txid-based one.
9007         // Technically this is allowed by the spec, but we don't support it and there's little reason
9008         // to. Still, it shouldn't cause any other issues.
9009         open_chan_msg.temporary_channel_id = channel_id;
9010         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9011         {
9012                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9013                 assert_eq!(events.len(), 1);
9014                 match events[0] {
9015                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9016                                 // Technically, at this point, nodes[1] would be justified in thinking both
9017                                 // channels are closed, but currently we do not, so we just move forward with it.
9018                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9019                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9020                         },
9021                         _ => panic!("Unexpected event"),
9022                 }
9023         }
9024
9025         // Now try to create a second channel which has a duplicate funding output.
9026         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9027         let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9028         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
9029         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()));
9030         create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
9031
9032         let funding_created = {
9033                 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
9034                 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
9035                 let logger = test_utils::TestLogger::new();
9036                 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
9037         };
9038         check_added_monitors!(nodes[0], 0);
9039         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
9040         // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
9041         // still needs to be cleared here.
9042         check_added_monitors!(nodes[1], 1);
9043
9044         // ...still, nodes[1] will reject the duplicate channel.
9045         {
9046                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9047                 assert_eq!(events.len(), 1);
9048                 match events[0] {
9049                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9050                                 // Technically, at this point, nodes[1] would be justified in thinking both
9051                                 // channels are closed, but currently we do not, so we just move forward with it.
9052                                 assert_eq!(msg.channel_id, channel_id);
9053                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9054                         },
9055                         _ => panic!("Unexpected event"),
9056                 }
9057         }
9058
9059         // finally, finish creating the original channel and send a payment over it to make sure
9060         // everything is functional.
9061         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9062         {
9063                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9064                 assert_eq!(added_monitors.len(), 1);
9065                 assert_eq!(added_monitors[0].0, funding_output);
9066                 added_monitors.clear();
9067         }
9068
9069         let events_4 = nodes[0].node.get_and_clear_pending_events();
9070         assert_eq!(events_4.len(), 0);
9071         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9072         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
9073
9074         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9075         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9076         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9077         send_payment(&nodes[0], &[&nodes[1]], 8000000);
9078 }
9079
9080 #[test]
9081 fn test_error_chans_closed() {
9082         // Test that we properly handle error messages, closing appropriate channels.
9083         //
9084         // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9085         // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9086         // we can test various edge cases around it to ensure we don't regress.
9087         let chanmon_cfgs = create_chanmon_cfgs(3);
9088         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9089         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9090         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9091
9092         // Create some initial channels
9093         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9094         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9095         let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9096
9097         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9098         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9099         assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9100
9101         // Closing a channel from a different peer has no effect
9102         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9103         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9104
9105         // Closing one channel doesn't impact others
9106         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9107         check_added_monitors!(nodes[0], 1);
9108         check_closed_broadcast!(nodes[0], false);
9109         check_closed_event!(nodes[0], 1);
9110         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9111         assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9112         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);
9113         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);
9114
9115         // A null channel ID should close all channels
9116         let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9117         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9118         check_added_monitors!(nodes[0], 2);
9119         check_closed_event!(nodes[0], 2);
9120         let events = nodes[0].node.get_and_clear_pending_msg_events();
9121         assert_eq!(events.len(), 2);
9122         match events[0] {
9123                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9124                         assert_eq!(msg.contents.flags & 2, 2);
9125                 },
9126                 _ => panic!("Unexpected event"),
9127         }
9128         match events[1] {
9129                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9130                         assert_eq!(msg.contents.flags & 2, 2);
9131                 },
9132                 _ => panic!("Unexpected event"),
9133         }
9134         // Note that at this point users of a standard PeerHandler will end up calling
9135         // peer_disconnected with no_connection_possible set to false, duplicating the
9136         // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9137         // users with their own peer handling logic. We duplicate the call here, however.
9138         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9139         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9140
9141         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9142         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9143         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9144 }
9145
9146 #[test]
9147 fn test_invalid_funding_tx() {
9148         // Test that we properly handle invalid funding transactions sent to us from a peer.
9149         //
9150         // Previously, all other major lightning implementations had failed to properly sanitize
9151         // funding transactions from their counterparties, leading to a multi-implementation critical
9152         // security vulnerability (though we always sanitized properly, we've previously had
9153         // un-released crashes in the sanitization process).
9154         let chanmon_cfgs = create_chanmon_cfgs(2);
9155         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9156         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9157         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9158
9159         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9160         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()));
9161         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()));
9162
9163         let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9164         for output in tx.output.iter_mut() {
9165                 // Make the confirmed funding transaction have a bogus script_pubkey
9166                 output.script_pubkey = bitcoin::Script::new();
9167         }
9168
9169         nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9170         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()));
9171         check_added_monitors!(nodes[1], 1);
9172
9173         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()));
9174         check_added_monitors!(nodes[0], 1);
9175
9176         let events_1 = nodes[0].node.get_and_clear_pending_events();
9177         assert_eq!(events_1.len(), 0);
9178
9179         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9180         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9181         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9182
9183         confirm_transaction_at(&nodes[1], &tx, 1);
9184         check_closed_event!(nodes[1], 1);
9185         check_added_monitors!(nodes[1], 1);
9186         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9187         assert_eq!(events_2.len(), 1);
9188         if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9189                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9190                 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9191                         assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9192                 } else { panic!(); }
9193         } else { panic!(); }
9194         assert_eq!(nodes[1].node.list_channels().len(), 0);
9195 }
9196
9197 fn do_test_tx_confirmed_skipping_blocks_immediate_broadcast(test_height_before_timelock: bool) {
9198         // In the first version of the chain::Confirm interface, after a refactor was made to not
9199         // broadcast CSV-locked transactions until their CSV lock is up, we wouldn't reliably broadcast
9200         // transactions after a `transactions_confirmed` call. Specifically, if the chain, provided via
9201         // `best_block_updated` is at height N, and a transaction output which we wish to spend at
9202         // height N-1 (due to a CSV to height N-1) is provided at height N, we will not broadcast the
9203         // spending transaction until height N+1 (or greater). This was due to the way
9204         // `ChannelMonitor::transactions_confirmed` worked, only checking if we should broadcast a
9205         // spending transaction at the height the input transaction was confirmed at, not whether we
9206         // should broadcast a spending transaction at the current height.
9207         // A second, similar, issue involved failing HTLCs backwards - because we only provided the
9208         // height at which transactions were confirmed to `OnchainTx::update_claims_view`, it wasn't
9209         // aware that the anti-reorg-delay had, in fact, already expired, waiting to fail-backwards
9210         // until we learned about an additional block.
9211         //
9212         // As an additional check, if `test_height_before_timelock` is set, we instead test that we
9213         // aren't broadcasting transactions too early (ie not broadcasting them at all).
9214         let chanmon_cfgs = create_chanmon_cfgs(3);
9215         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9216         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9217         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9218         *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
9219
9220         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
9221         let (chan_announce, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
9222         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
9223         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
9224         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
9225
9226         nodes[1].node.force_close_channel(&channel_id).unwrap();
9227         check_closed_broadcast!(nodes[1], true);
9228         check_closed_event!(nodes[1], 1);
9229         check_added_monitors!(nodes[1], 1);
9230         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9231         assert_eq!(node_txn.len(), 1);
9232
9233         let conf_height = nodes[1].best_block_info().1;
9234         if !test_height_before_timelock {
9235                 connect_blocks(&nodes[1], 24 * 6);
9236         }
9237         nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9238                 &nodes[1].get_block_header(conf_height), &[(0, &node_txn[0])], conf_height);
9239         if test_height_before_timelock {
9240                 // If we confirmed the close transaction, but timelocks have not yet expired, we should not
9241                 // generate any events or broadcast any transactions
9242                 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
9243                 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
9244         } else {
9245                 // We should broadcast an HTLC transaction spending our funding transaction first
9246                 let spending_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9247                 assert_eq!(spending_txn.len(), 2);
9248                 assert_eq!(spending_txn[0], node_txn[0]);
9249                 check_spends!(spending_txn[1], node_txn[0]);
9250                 // We should also generate a SpendableOutputs event with the to_self output (as its
9251                 // timelock is up).
9252                 let descriptor_spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
9253                 assert_eq!(descriptor_spend_txn.len(), 1);
9254
9255                 // If we also discover that the HTLC-Timeout transaction was confirmed some time ago, we
9256                 // should immediately fail-backwards the HTLC to the previous hop, without waiting for an
9257                 // additional block built on top of the current chain.
9258                 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9259                         &nodes[1].get_block_header(conf_height + 1), &[(0, &spending_txn[1])], conf_height + 1);
9260                 let events = nodes[1].node.get_and_clear_pending_events();
9261                 expect_pending_htlcs_forwardable!(nodes[1], events);
9262                 check_added_monitors!(nodes[1], 1);
9263
9264                 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9265                 assert!(updates.update_add_htlcs.is_empty());
9266                 assert!(updates.update_fulfill_htlcs.is_empty());
9267                 assert_eq!(updates.update_fail_htlcs.len(), 1);
9268                 assert!(updates.update_fail_malformed_htlcs.is_empty());
9269                 assert!(updates.update_fee.is_none());
9270                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9271                 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9272                 expect_payment_failed_with_update!(nodes[0], payment_hash, false, chan_announce.contents.short_channel_id, true);
9273         }
9274 }
9275
9276 #[test]
9277 fn test_tx_confirmed_skipping_blocks_immediate_broadcast() {
9278         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(false);
9279         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(true);
9280 }
9281
9282 #[test]
9283 fn test_keysend_payments_to_public_node() {
9284         let chanmon_cfgs = create_chanmon_cfgs(2);
9285         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9286         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9287         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9288
9289         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9290         let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
9291         let payer_pubkey = nodes[0].node.get_our_node_id();
9292         let payee_pubkey = nodes[1].node.get_our_node_id();
9293         let route = get_route(&payer_pubkey, network_graph, &payee_pubkey, None,
9294                         None, &vec![], 10000, 40,
9295                         nodes[0].logger).unwrap();
9296
9297         let test_preimage = PaymentPreimage([42; 32]);
9298         let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage)).unwrap();
9299         check_added_monitors!(nodes[0], 1);
9300         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9301         assert_eq!(events.len(), 1);
9302         let event = events.pop().unwrap();
9303         let path = vec![&nodes[1]];
9304         pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9305         claim_payment(&nodes[0], &path, test_preimage);
9306 }
9307
9308 #[test]
9309 fn test_keysend_payments_to_private_node() {
9310         let chanmon_cfgs = create_chanmon_cfgs(2);
9311         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9312         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9313         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9314
9315         let payer_pubkey = nodes[0].node.get_our_node_id();
9316         let payee_pubkey = nodes[1].node.get_our_node_id();
9317         nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known() });
9318         nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known() });
9319
9320         let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
9321         let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
9322         let first_hops = nodes[0].node.list_usable_channels();
9323         let route = get_keysend_route(&payer_pubkey, &network_graph, &payee_pubkey,
9324                                 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
9325                                 nodes[0].logger).unwrap();
9326
9327         let test_preimage = PaymentPreimage([42; 32]);
9328         let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage)).unwrap();
9329         check_added_monitors!(nodes[0], 1);
9330         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9331         assert_eq!(events.len(), 1);
9332         let event = events.pop().unwrap();
9333         let path = vec![&nodes[1]];
9334         pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9335         claim_payment(&nodes[0], &path, test_preimage);
9336 }
9337
9338 fn do_test_max_dust_htlc_exposure(dust_outbound_balance: bool, at_forward: bool, on_holder_tx: bool) {
9339         // Test that we properly reject dust HTLC violating our `max_dust_htlc_exposure_msat` policy.
9340         //
9341         // At HTLC forward (`send_payment()`), if the sum of the trimmed-to-dust HTLC inbound and
9342         // trimmed-to-dust HTLC outbound balance and this new payment as included on next counterparty
9343         // commitment are above our `max_dust_htlc_exposure_msat`, we'll reject the update.
9344         // At HTLC reception (`update_add_htlc()`), if the sum of the trimmed-to-dust HTLC inbound
9345         // and trimmed-to-dust HTLC outbound balance and this new received HTLC as included on next
9346         // counterparty commitment are above our `max_dust_htlc_exposure_msat`, we'll fail the update.
9347         // Note, we return a `temporary_channel_failure` (0x1000 | 7), as the channel might be
9348         // available again for HTLC processing once the dust bandwidth has cleared up.
9349
9350         let chanmon_cfgs = create_chanmon_cfgs(2);
9351         let mut config = test_default_channel_config();
9352         config.channel_options.max_dust_htlc_exposure_msat = 5_000_000; // default setting value
9353         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9354         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(config)]);
9355         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9356
9357         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
9358         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9359         open_channel.max_htlc_value_in_flight_msat = 50_000_000;
9360         open_channel.max_accepted_htlcs = 60;
9361         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
9362         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9363         if on_holder_tx {
9364                 accept_channel.dust_limit_satoshis = 660;
9365         }
9366         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
9367
9368         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 1_000_000, 42);
9369
9370         if on_holder_tx {
9371                 if let Some(mut chan) = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&temporary_channel_id) {
9372                         chan.holder_dust_limit_satoshis = 660;
9373                 }
9374         }
9375
9376         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9377         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()));
9378         check_added_monitors!(nodes[1], 1);
9379
9380         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()));
9381         check_added_monitors!(nodes[0], 1);
9382
9383         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9384         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9385         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9386
9387         if on_holder_tx {
9388                 if dust_outbound_balance {
9389                         for i in 0..2 {
9390                                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 2_300_000);
9391                                 if let Err(_) = nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)) { panic!("Unexpected event at dust HTLC {}", i); }
9392                         }
9393                 } else {
9394                         for _ in 0..2 {
9395                                 route_payment(&nodes[0], &[&nodes[1]], 2_300_000);
9396                         }
9397                 }
9398         } else {
9399                 if dust_outbound_balance {
9400                         for i in 0..25 {
9401                                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 200_000); // + 177_000 msat of HTLC-success tx at 253 sats/kWU
9402                                 if let Err(_) = nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)) { panic!("Unexpected event at dust HTLC {}", i); }
9403                         }
9404                 } else {
9405                         for _ in 0..25 {
9406                                 route_payment(&nodes[0], &[&nodes[1]], 200_000); // + 167_000 msat of HTLC-timeout tx at 253 sats/kWU
9407                         }
9408                 }
9409         }
9410
9411         if at_forward {
9412                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], if on_holder_tx { 2_300_000 } else { 200_000 });
9413                 let mut config = UserConfig::default();
9414                 if on_holder_tx {
9415                         unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable { ref err }, assert_eq!(err, &format!("Cannot send value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx", 6_900_000, config.channel_options.max_dust_htlc_exposure_msat)));
9416                 } else {
9417                         unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable { ref err }, assert_eq!(err, &format!("Cannot send value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx", 5_200_000, config.channel_options.max_dust_htlc_exposure_msat)));
9418                 }
9419         } else {
9420                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1 ], if on_holder_tx { 2_300_000 } else { 200_000 });
9421                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
9422                 check_added_monitors!(nodes[0], 1);
9423                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9424                 assert_eq!(events.len(), 1);
9425                 let payment_event = SendEvent::from_event(events.remove(0));
9426                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9427                 if on_holder_tx {
9428                         nodes[1].logger.assert_log("lightning::ln::channel".to_string(), format!("Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx", 6_900_000, config.channel_options.max_dust_htlc_exposure_msat), 1);
9429                 } else {
9430                         nodes[1].logger.assert_log("lightning::ln::channel".to_string(), format!("Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx", 5_200_000, config.channel_options.max_dust_htlc_exposure_msat), 1);
9431                 }
9432         }
9433
9434         let _ = nodes[1].node.get_and_clear_pending_msg_events();
9435         let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9436         added_monitors.clear();
9437 }
9438
9439 #[test]
9440 fn test_max_dust_htlc_exposure() {
9441         do_test_max_dust_htlc_exposure(true, true, true);
9442         do_test_max_dust_htlc_exposure(false, true, true);
9443         do_test_max_dust_htlc_exposure(false, false, true);
9444         do_test_max_dust_htlc_exposure(false, false, false);
9445         do_test_max_dust_htlc_exposure(true, true, false);
9446         do_test_max_dust_htlc_exposure(true, false, false);
9447         do_test_max_dust_htlc_exposure(true, false, true);
9448         do_test_max_dust_htlc_exposure(false, true, false);
9449 }