_ 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 crate::chain;
  15 use crate::chain::{ChannelMonitorUpdateStatus, Confirm, Listen, Watch};
  16 use crate::chain::chaininterface::LowerBoundedFeeEstimator;
  17 use crate::chain::channelmonitor;
  18 use crate::chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
  19 use crate::chain::transaction::OutPoint;
  20 use crate::chain::keysinterface::{ChannelSigner, EcdsaChannelSigner, EntropySource};
  21 use crate::ln::{PaymentPreimage, PaymentSecret, PaymentHash};
  22 use crate::ln::channel::{commitment_tx_base_weight, COMMITMENT_TX_WEIGHT_PER_HTLC, CONCURRENT_INBOUND_HTLC_FEE_BUFFER, FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE, MIN_AFFORDABLE_HTLC_COUNT};
  23 use crate::ln::channelmanager::{self, PaymentId, RAACommitmentOrder, PaymentSendFailure, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA};
  24 use crate::ln::channel::{Channel, ChannelError};
  25 use crate::ln::{chan_utils, onion_utils};
  26 use crate::ln::chan_utils::{OFFERED_HTLC_SCRIPT_WEIGHT, htlc_success_tx_weight, htlc_timeout_tx_weight, HTLCOutputInCommitment};
  27 use crate::routing::gossip::{NetworkGraph, NetworkUpdate};
  28 use crate::routing::router::{PaymentParameters, Route, RouteHop, RouteParameters, find_route, get_route};
  29 use crate::ln::features::{ChannelFeatures, NodeFeatures};
  30 use crate::ln::msgs;
  31 use crate::ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
  32 use crate::util::enforcing_trait_impls::EnforcingSigner;
  33 use crate::util::test_utils;
  34 use crate::util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose, ClosureReason, HTLCDestination};
  35 use crate::util::errors::APIError;
  36 use crate::util::ser::{Writeable, ReadableArgs};
  37 use crate::util::config::UserConfig;
  38
  39 use bitcoin::hash_types::BlockHash;
  40 use bitcoin::blockdata::block::{Block, BlockHeader};
  41 use bitcoin::blockdata::script::{Builder, Script};
  42 use bitcoin::blockdata::opcodes;
  43 use bitcoin::blockdata::constants::genesis_block;
  44 use bitcoin::network::constants::Network;
  45 use bitcoin::{PackedLockTime, Sequence, Transaction, TxIn, TxMerkleNode, TxOut, Witness};
  46 use bitcoin::OutPoint as BitcoinOutPoint;
  47
  48 use bitcoin::secp256k1::Secp256k1;
  49 use bitcoin::secp256k1::{PublicKey,SecretKey};
  50
  51 use regex;
  52
  53 use crate::io;
  54 use crate::prelude::*;
  55 use alloc::collections::BTreeSet;
  56 use core::default::Default;
  57 use core::iter::repeat;
  58 use bitcoin::hashes::Hash;
  59 use crate::sync::{Arc, Mutex};
  60
  61 use crate::ln::functional_test_utils::*;
  62 use crate::ln::chan_utils::CommitmentTransaction;
  63
  64 #[test]
  65 fn test_insane_channel_opens() {
  66         // Stand up a network of 2 nodes
  67         use crate::ln::channel::TOTAL_BITCOIN_SUPPLY_SATOSHIS;
  68         let mut cfg = UserConfig::default();
  69         cfg.channel_handshake_limits.max_funding_satoshis = TOTAL_BITCOIN_SUPPLY_SATOSHIS + 1;
  70         let chanmon_cfgs = create_chanmon_cfgs(2);
  71         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  72         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(cfg)]);
  73         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  74
  75         // Instantiate channel parameters where we push the maximum msats given our
  76         // funding satoshis
  77         let channel_value_sat = 31337; // same as funding satoshis
  78         let channel_reserve_satoshis = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value_sat, &cfg);
  79         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  80
  81         // Have node0 initiate a channel to node1 with aforementioned parameters
  82         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
  83
  84         // Extract the channel open message from node0 to node1
  85         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  86
  87         // Test helper that asserts we get the correct error string given a mutator
  88         // that supposedly makes the channel open message insane
  89         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  90                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &message_mutator(open_channel_message.clone()));
  91                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  92                 assert_eq!(msg_events.len(), 1);
  93                 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
  94                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  95                         match action {
  96                                 &ErrorAction::SendErrorMessage { .. } => {
  97                                         nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
  98                                 },
  99                                 _ => panic!("unexpected event!"),
 100                         }
 101                 } else { assert!(false); }
 102         };
 103
 104         use crate::ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
 105
 106         // Test all mutations that would make the channel open message insane
 107         insane_open_helper(format!("Per our config, funding must be at most {}. It was {}", TOTAL_BITCOIN_SUPPLY_SATOSHIS + 1, TOTAL_BITCOIN_SUPPLY_SATOSHIS + 2).as_str(), |mut msg| { msg.funding_satoshis = TOTAL_BITCOIN_SUPPLY_SATOSHIS + 2; msg });
 108         insane_open_helper(format!("Funding must be smaller than the total bitcoin supply. It was {}", TOTAL_BITCOIN_SUPPLY_SATOSHIS).as_str(), |mut msg| { msg.funding_satoshis = TOTAL_BITCOIN_SUPPLY_SATOSHIS; msg });
 109
 110         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
 111
 112         insane_open_helper(r"push_msat \d+ was larger than channel amount minus reserve \(\d+\)", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
 113
 114         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
 115
 116         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 });
 117
 118         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 });
 119
 120         insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 121
 122         insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 123 }
 124
 125 #[test]
 126 fn test_funding_exceeds_no_wumbo_limit() {
 127         // Test that if a peer does not support wumbo channels, we'll refuse to open a wumbo channel to
 128         // them.
 129         use crate::ln::channel::MAX_FUNDING_SATOSHIS_NO_WUMBO;
 130         let chanmon_cfgs = create_chanmon_cfgs(2);
 131         let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 132         *node_cfgs[1].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&test_default_channel_config()).clear_wumbo());
 133         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 134         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 135
 136         match nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), MAX_FUNDING_SATOSHIS_NO_WUMBO + 1, 0, 42, None) {
 137                 Err(APIError::APIMisuseError { err }) => {
 138                         assert_eq!(format!("funding_value must not exceed {}, it was {}", MAX_FUNDING_SATOSHIS_NO_WUMBO, MAX_FUNDING_SATOSHIS_NO_WUMBO + 1), err);
 139                 },
 140                 _ => panic!()
 141         }
 142 }
 143
 144 fn do_test_counterparty_no_reserve(send_from_initiator: bool) {
 145         // A peer providing a channel_reserve_satoshis of 0 (or less than our dust limit) is insecure,
 146         // but only for them. Because some LSPs do it with some level of trust of the clients (for a
 147         // substantial UX improvement), we explicitly allow it. Because it's unlikely to happen often
 148         // in normal testing, we test it explicitly here.
 149         let chanmon_cfgs = create_chanmon_cfgs(2);
 150         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 151         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 152         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 153         let default_config = UserConfig::default();
 154
 155         // Have node0 initiate a channel to node1 with aforementioned parameters
 156         let mut push_amt = 100_000_000;
 157         let feerate_per_kw = 253;
 158         let opt_anchors = false;
 159         push_amt -= feerate_per_kw as u64 * (commitment_tx_base_weight(opt_anchors) + 4 * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000 * 1000;
 160         push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000, &default_config) * 1000;
 161
 162         let temp_channel_id = nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, if send_from_initiator { 0 } else { push_amt }, 42, None).unwrap();
 163         let mut open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 164         if !send_from_initiator {
 165                 open_channel_message.channel_reserve_satoshis = 0;
 166                 open_channel_message.max_htlc_value_in_flight_msat = 100_000_000;
 167         }
 168         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_message);
 169
 170         // Extract the channel accept message from node1 to node0
 171         let mut accept_channel_message = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 172         if send_from_initiator {
 173                 accept_channel_message.channel_reserve_satoshis = 0;
 174                 accept_channel_message.max_htlc_value_in_flight_msat = 100_000_000;
 175         }
 176         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel_message);
 177         {
 178                 let sender_node = if send_from_initiator { &nodes[1] } else { &nodes[0] };
 179                 let counterparty_node = if send_from_initiator { &nodes[0] } else { &nodes[1] };
 180                 let mut sender_node_per_peer_lock;
 181                 let mut sender_node_peer_state_lock;
 182                 let mut chan = get_channel_ref!(sender_node, counterparty_node, sender_node_per_peer_lock, sender_node_peer_state_lock, temp_channel_id);
 183                 chan.holder_selected_channel_reserve_satoshis = 0;
 184                 chan.holder_max_htlc_value_in_flight_msat = 100_000_000;
 185         }
 186
 187         let funding_tx = sign_funding_transaction(&nodes[0], &nodes[1], 100_000, temp_channel_id);
 188         let funding_msgs = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &funding_tx);
 189         create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_msgs.0);
 190
 191         // nodes[0] should now be able to send the full balance to nodes[1], violating nodes[1]'s
 192         // security model if it ever tries to send funds back to nodes[0] (but that's not our problem).
 193         if send_from_initiator {
 194                 send_payment(&nodes[0], &[&nodes[1]], 100_000_000
 195                         // Note that for outbound channels we have to consider the commitment tx fee and the
 196                         // "fee spike buffer", which is currently a multiple of the total commitment tx fee as
 197                         // well as an additional HTLC.
 198                         - FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE * commit_tx_fee_msat(feerate_per_kw, 2, opt_anchors));
 199         } else {
 200                 send_payment(&nodes[1], &[&nodes[0]], push_amt);
 201         }
 202 }
 203
 204 #[test]
 205 fn test_counterparty_no_reserve() {
 206         do_test_counterparty_no_reserve(true);
 207         do_test_counterparty_no_reserve(false);
 208 }
 209
 210 #[test]
 211 fn test_async_inbound_update_fee() {
 212         let chanmon_cfgs = create_chanmon_cfgs(2);
 213         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 214         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 215         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 216         create_announced_chan_between_nodes(&nodes, 0, 1);
 217
 218         // balancing
 219         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 220
 221         // A                                        B
 222         // update_fee                            ->
 223         // send (1) commitment_signed            -.
 224         //                                       <- update_add_htlc/commitment_signed
 225         // send (2) RAA (awaiting remote revoke) -.
 226         // (1) commitment_signed is delivered    ->
 227         //                                       .- send (3) RAA (awaiting remote revoke)
 228         // (2) RAA is delivered                  ->
 229         //                                       .- send (4) commitment_signed
 230         //                                       <- (3) RAA is delivered
 231         // send (5) commitment_signed            -.
 232         //                                       <- (4) commitment_signed is delivered
 233         // send (6) RAA                          -.
 234         // (5) commitment_signed is delivered    ->
 235         //                                       <- RAA
 236         // (6) RAA is delivered                  ->
 237
 238         // First nodes[0] generates an update_fee
 239         {
 240                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 241                 *feerate_lock += 20;
 242         }
 243         nodes[0].node.timer_tick_occurred();
 244         check_added_monitors!(nodes[0], 1);
 245
 246         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 247         assert_eq!(events_0.len(), 1);
 248         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 249                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 250                         (update_fee.as_ref(), commitment_signed)
 251                 },
 252                 _ => panic!("Unexpected event"),
 253         };
 254
 255         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 256
 257         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 258         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 40000);
 259         nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
 260         check_added_monitors!(nodes[1], 1);
 261
 262         let payment_event = {
 263                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 264                 assert_eq!(events_1.len(), 1);
 265                 SendEvent::from_event(events_1.remove(0))
 266         };
 267         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 268         assert_eq!(payment_event.msgs.len(), 1);
 269
 270         // ...now when the messages get delivered everyone should be happy
 271         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 272         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 273         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 274         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 275         check_added_monitors!(nodes[0], 1);
 276
 277         // deliver(1), generate (3):
 278         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 279         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 280         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 281         check_added_monitors!(nodes[1], 1);
 282
 283         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 284         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 285         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 286         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 287         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 288         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 289         assert!(bs_update.update_fee.is_none()); // (4)
 290         check_added_monitors!(nodes[1], 1);
 291
 292         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 293         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 294         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 295         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 296         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 297         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 298         assert!(as_update.update_fee.is_none()); // (5)
 299         check_added_monitors!(nodes[0], 1);
 300
 301         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 302         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 303         // only (6) so get_event_msg's assert(len == 1) passes
 304         check_added_monitors!(nodes[0], 1);
 305
 306         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 307         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 308         check_added_monitors!(nodes[1], 1);
 309
 310         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 311         check_added_monitors!(nodes[0], 1);
 312
 313         let events_2 = nodes[0].node.get_and_clear_pending_events();
 314         assert_eq!(events_2.len(), 1);
 315         match events_2[0] {
 316                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 317                 _ => panic!("Unexpected event"),
 318         }
 319
 320         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 321         check_added_monitors!(nodes[1], 1);
 322 }
 323
 324 #[test]
 325 fn test_update_fee_unordered_raa() {
 326         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 327         // crash in an earlier version of the update_fee patch)
 328         let chanmon_cfgs = create_chanmon_cfgs(2);
 329         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 330         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 331         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 332         create_announced_chan_between_nodes(&nodes, 0, 1);
 333
 334         // balancing
 335         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 336
 337         // First nodes[0] generates an update_fee
 338         {
 339                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 340                 *feerate_lock += 20;
 341         }
 342         nodes[0].node.timer_tick_occurred();
 343         check_added_monitors!(nodes[0], 1);
 344
 345         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 346         assert_eq!(events_0.len(), 1);
 347         let update_msg = match events_0[0] { // (1)
 348                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 349                         update_fee.as_ref()
 350                 },
 351                 _ => panic!("Unexpected event"),
 352         };
 353
 354         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 355
 356         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 357         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 40000);
 358         nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
 359         check_added_monitors!(nodes[1], 1);
 360
 361         let payment_event = {
 362                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 363                 assert_eq!(events_1.len(), 1);
 364                 SendEvent::from_event(events_1.remove(0))
 365         };
 366         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 367         assert_eq!(payment_event.msgs.len(), 1);
 368
 369         // ...now when the messages get delivered everyone should be happy
 370         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 371         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 372         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 373         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 374         check_added_monitors!(nodes[0], 1);
 375
 376         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 377         check_added_monitors!(nodes[1], 1);
 378
 379         // We can't continue, sadly, because our (1) now has a bogus signature
 380 }
 381
 382 #[test]
 383 fn test_multi_flight_update_fee() {
 384         let chanmon_cfgs = create_chanmon_cfgs(2);
 385         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 386         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 387         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 388         create_announced_chan_between_nodes(&nodes, 0, 1);
 389
 390         // A                                        B
 391         // update_fee/commitment_signed          ->
 392         //                                       .- send (1) RAA and (2) commitment_signed
 393         // update_fee (never committed)          ->
 394         // (3) update_fee                        ->
 395         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 396         // don't track which updates correspond to which revoke_and_ack responses so we're in
 397         // AwaitingRAA mode and will not generate the update_fee yet.
 398         //                                       <- (1) RAA delivered
 399         // (3) is generated and send (4) CS      -.
 400         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 401         // know the per_commitment_point to use for it.
 402         //                                       <- (2) commitment_signed delivered
 403         // revoke_and_ack                        ->
 404         //                                          B should send no response here
 405         // (4) commitment_signed delivered       ->
 406         //                                       <- RAA/commitment_signed delivered
 407         // revoke_and_ack                        ->
 408
 409         // First nodes[0] generates an update_fee
 410         let initial_feerate;
 411         {
 412                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 413                 initial_feerate = *feerate_lock;
 414                 *feerate_lock = initial_feerate + 20;
 415         }
 416         nodes[0].node.timer_tick_occurred();
 417         check_added_monitors!(nodes[0], 1);
 418
 419         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 420         assert_eq!(events_0.len(), 1);
 421         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 422                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 423                         (update_fee.as_ref().unwrap(), commitment_signed)
 424                 },
 425                 _ => panic!("Unexpected event"),
 426         };
 427
 428         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 429         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 430         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 431         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 432         check_added_monitors!(nodes[1], 1);
 433
 434         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 435         // transaction:
 436         {
 437                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 438                 *feerate_lock = initial_feerate + 40;
 439         }
 440         nodes[0].node.timer_tick_occurred();
 441         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 442         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 443
 444         // Create the (3) update_fee message that nodes[0] will generate before it does...
 445         let mut update_msg_2 = msgs::UpdateFee {
 446                 channel_id: update_msg_1.channel_id.clone(),
 447                 feerate_per_kw: (initial_feerate + 30) as u32,
 448         };
 449
 450         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 451
 452         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 453         // Deliver (3)
 454         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 455
 456         // Deliver (1), generating (3) and (4)
 457         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 458         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 459         check_added_monitors!(nodes[0], 1);
 460         assert!(as_second_update.update_add_htlcs.is_empty());
 461         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 462         assert!(as_second_update.update_fail_htlcs.is_empty());
 463         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 464         // Check that the update_fee newly generated matches what we delivered:
 465         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 466         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 467
 468         // Deliver (2) commitment_signed
 469         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 470         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 471         check_added_monitors!(nodes[0], 1);
 472         // No commitment_signed so get_event_msg's assert(len == 1) passes
 473
 474         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 475         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 476         check_added_monitors!(nodes[1], 1);
 477
 478         // Delever (4)
 479         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 480         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 481         check_added_monitors!(nodes[1], 1);
 482
 483         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 484         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 485         check_added_monitors!(nodes[0], 1);
 486
 487         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 488         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 489         // No commitment_signed so get_event_msg's assert(len == 1) passes
 490         check_added_monitors!(nodes[0], 1);
 491
 492         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 493         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 494         check_added_monitors!(nodes[1], 1);
 495 }
 496
 497 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 498         // Previously, we had issues deserializing channels when we hadn't connected the first block
 499         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 500         // serialization round-trips and simply do steps towards opening a channel and then drop the
 501         // Node objects.
 502
 503         let chanmon_cfgs = create_chanmon_cfgs(2);
 504         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 505         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 506         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 507
 508         if steps & 0b1000_0000 != 0{
 509                 let block = Block {
 510                         header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
 511                         txdata: vec![],
 512                 };
 513                 connect_block(&nodes[0], &block);
 514                 connect_block(&nodes[1], &block);
 515         }
 516
 517         if steps & 0x0f == 0 { return; }
 518         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 519         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 520
 521         if steps & 0x0f == 1 { return; }
 522         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
 523         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 524
 525         if steps & 0x0f == 2 { return; }
 526         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
 527
 528         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 42);
 529
 530         if steps & 0x0f == 3 { return; }
 531         nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
 532         check_added_monitors!(nodes[0], 0);
 533         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 534
 535         if steps & 0x0f == 4 { return; }
 536         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 537         {
 538                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 539                 assert_eq!(added_monitors.len(), 1);
 540                 assert_eq!(added_monitors[0].0, funding_output);
 541                 added_monitors.clear();
 542         }
 543         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 544
 545         if steps & 0x0f == 5 { return; }
 546         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 547         {
 548                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 549                 assert_eq!(added_monitors.len(), 1);
 550                 assert_eq!(added_monitors[0].0, funding_output);
 551                 added_monitors.clear();
 552         }
 553
 554         let events_4 = nodes[0].node.get_and_clear_pending_events();
 555         assert_eq!(events_4.len(), 0);
 556
 557         if steps & 0x0f == 6 { return; }
 558         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
 559
 560         if steps & 0x0f == 7 { return; }
 561         confirm_transaction_at(&nodes[0], &tx, 2);
 562         connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
 563         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 564         expect_channel_ready_event(&nodes[0], &nodes[1].node.get_our_node_id());
 565 }
 566
 567 #[test]
 568 fn test_sanity_on_in_flight_opens() {
 569         do_test_sanity_on_in_flight_opens(0);
 570         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 571         do_test_sanity_on_in_flight_opens(1);
 572         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 573         do_test_sanity_on_in_flight_opens(2);
 574         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 575         do_test_sanity_on_in_flight_opens(3);
 576         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 577         do_test_sanity_on_in_flight_opens(4);
 578         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 579         do_test_sanity_on_in_flight_opens(5);
 580         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 581         do_test_sanity_on_in_flight_opens(6);
 582         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 583         do_test_sanity_on_in_flight_opens(7);
 584         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 585         do_test_sanity_on_in_flight_opens(8);
 586         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 587 }
 588
 589 #[test]
 590 fn test_update_fee_vanilla() {
 591         let chanmon_cfgs = create_chanmon_cfgs(2);
 592         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 593         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 594         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 595         create_announced_chan_between_nodes(&nodes, 0, 1);
 596
 597         {
 598                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 599                 *feerate_lock += 25;
 600         }
 601         nodes[0].node.timer_tick_occurred();
 602         check_added_monitors!(nodes[0], 1);
 603
 604         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 605         assert_eq!(events_0.len(), 1);
 606         let (update_msg, commitment_signed) = match events_0[0] {
 607                         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 } } => {
 608                         (update_fee.as_ref(), commitment_signed)
 609                 },
 610                 _ => panic!("Unexpected event"),
 611         };
 612         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 613
 614         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 615         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 616         check_added_monitors!(nodes[1], 1);
 617
 618         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 619         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 620         check_added_monitors!(nodes[0], 1);
 621
 622         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 623         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 624         // No commitment_signed so get_event_msg's assert(len == 1) passes
 625         check_added_monitors!(nodes[0], 1);
 626
 627         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 628         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 629         check_added_monitors!(nodes[1], 1);
 630 }
 631
 632 #[test]
 633 fn test_update_fee_that_funder_cannot_afford() {
 634         let chanmon_cfgs = create_chanmon_cfgs(2);
 635         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 636         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 637         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 638         let channel_value = 5000;
 639         let push_sats = 700;
 640         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, push_sats * 1000);
 641         let channel_id = chan.2;
 642         let secp_ctx = Secp256k1::new();
 643         let default_config = UserConfig::default();
 644         let bs_channel_reserve_sats = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value, &default_config);
 645
 646         let opt_anchors = false;
 647
 648         // Calculate the maximum feerate that A can afford. Note that we don't send an update_fee
 649         // CONCURRENT_INBOUND_HTLC_FEE_BUFFER HTLCs before actually running out of local balance, so we
 650         // calculate two different feerates here - the expected local limit as well as the expected
 651         // remote limit.
 652         let feerate = ((channel_value - bs_channel_reserve_sats - push_sats) * 1000 / (commitment_tx_base_weight(opt_anchors) + CONCURRENT_INBOUND_HTLC_FEE_BUFFER as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC)) as u32;
 653         let non_buffer_feerate = ((channel_value - bs_channel_reserve_sats - push_sats) * 1000 / commitment_tx_base_weight(opt_anchors)) as u32;
 654         {
 655                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 656                 *feerate_lock = feerate;
 657         }
 658         nodes[0].node.timer_tick_occurred();
 659         check_added_monitors!(nodes[0], 1);
 660         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 661
 662         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 663
 664         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 665
 666         // Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate set above.
 667         {
 668                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 669
 670                 //We made sure neither party's funds are below the dust limit and there are no HTLCs here
 671                 assert_eq!(commitment_tx.output.len(), 2);
 672                 let total_fee: u64 = commit_tx_fee_msat(feerate, 0, opt_anchors) / 1000;
 673                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 674                 actual_fee = channel_value - actual_fee;
 675                 assert_eq!(total_fee, actual_fee);
 676         }
 677
 678         {
 679                 // Increment the feerate by a small constant, accounting for rounding errors
 680                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 681                 *feerate_lock += 4;
 682         }
 683         nodes[0].node.timer_tick_occurred();
 684         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), format!("Cannot afford to send new feerate at {}", feerate + 4), 1);
 685         check_added_monitors!(nodes[0], 0);
 686
 687         const INITIAL_COMMITMENT_NUMBER: u64 = 281474976710654;
 688
 689         // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
 690         // needed to sign the new commitment tx and (2) sign the new commitment tx.
 691         let (local_revocation_basepoint, local_htlc_basepoint, local_funding) = {
 692                 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
 693                 let chan_lock = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
 694                 let local_chan = chan_lock.channel_by_id.get(&chan.2).unwrap();
 695                 let chan_signer = local_chan.get_signer();
 696                 let pubkeys = chan_signer.pubkeys();
 697                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
 698                  pubkeys.funding_pubkey)
 699         };
 700         let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point, remote_funding) = {
 701                 let per_peer_state = nodes[1].node.per_peer_state.read().unwrap();
 702                 let chan_lock = per_peer_state.get(&nodes[0].node.get_our_node_id()).unwrap().lock().unwrap();
 703                 let remote_chan = chan_lock.channel_by_id.get(&chan.2).unwrap();
 704                 let chan_signer = remote_chan.get_signer();
 705                 let pubkeys = chan_signer.pubkeys();
 706                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
 707                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx),
 708                  pubkeys.funding_pubkey)
 709         };
 710
 711         // Assemble the set of keys we can use for signatures for our commitment_signed message.
 712         let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
 713                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint);
 714
 715         let res = {
 716                 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
 717                 let local_chan_lock = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
 718                 let local_chan = local_chan_lock.channel_by_id.get(&chan.2).unwrap();
 719                 let local_chan_signer = local_chan.get_signer();
 720                 let mut htlcs: Vec<(HTLCOutputInCommitment, ())> = vec![];
 721                 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
 722                         INITIAL_COMMITMENT_NUMBER - 1,
 723                         push_sats,
 724                         channel_value - push_sats - commit_tx_fee_msat(non_buffer_feerate + 4, 0, opt_anchors) / 1000,
 725                         opt_anchors, local_funding, remote_funding,
 726                         commit_tx_keys.clone(),
 727                         non_buffer_feerate + 4,
 728                         &mut htlcs,
 729                         &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
 730                 );
 731                 local_chan_signer.sign_counterparty_commitment(&commitment_tx, Vec::new(), &secp_ctx).unwrap()
 732         };
 733
 734         let commit_signed_msg = msgs::CommitmentSigned {
 735                 channel_id: chan.2,
 736                 signature: res.0,
 737                 htlc_signatures: res.1
 738         };
 739
 740         let update_fee = msgs::UpdateFee {
 741                 channel_id: chan.2,
 742                 feerate_per_kw: non_buffer_feerate + 4,
 743         };
 744
 745         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_fee);
 746
 747         //While producing the commitment_signed response after handling a received update_fee request the
 748         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 749         //Should produce and error.
 750         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
 751         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 752         check_added_monitors!(nodes[1], 1);
 753         check_closed_broadcast!(nodes[1], true);
 754         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: String::from("Funding remote cannot afford proposed new fee") });
 755 }
 756
 757 #[test]
 758 fn test_update_fee_with_fundee_update_add_htlc() {
 759         let chanmon_cfgs = create_chanmon_cfgs(2);
 760         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 761         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 762         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 763         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 764
 765         // balancing
 766         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 767
 768         {
 769                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 770                 *feerate_lock += 20;
 771         }
 772         nodes[0].node.timer_tick_occurred();
 773         check_added_monitors!(nodes[0], 1);
 774
 775         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 776         assert_eq!(events_0.len(), 1);
 777         let (update_msg, commitment_signed) = match events_0[0] {
 778                         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 } } => {
 779                         (update_fee.as_ref(), commitment_signed)
 780                 },
 781                 _ => panic!("Unexpected event"),
 782         };
 783         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 784         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 785         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 786         check_added_monitors!(nodes[1], 1);
 787
 788         let (route, our_payment_hash, our_payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 800000);
 789
 790         // nothing happens since node[1] is in AwaitingRemoteRevoke
 791         nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
 792         {
 793                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 794                 assert_eq!(added_monitors.len(), 0);
 795                 added_monitors.clear();
 796         }
 797         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 798         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 799         // node[1] has nothing to do
 800
 801         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 802         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 803         check_added_monitors!(nodes[0], 1);
 804
 805         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 806         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 807         // No commitment_signed so get_event_msg's assert(len == 1) passes
 808         check_added_monitors!(nodes[0], 1);
 809         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 810         check_added_monitors!(nodes[1], 1);
 811         // AwaitingRemoteRevoke ends here
 812
 813         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 814         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 815         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 816         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 817         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 818         assert_eq!(commitment_update.update_fee.is_none(), true);
 819
 820         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 821         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 822         check_added_monitors!(nodes[0], 1);
 823         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 824
 825         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 826         check_added_monitors!(nodes[1], 1);
 827         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 828
 829         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 830         check_added_monitors!(nodes[1], 1);
 831         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 832         // No commitment_signed so get_event_msg's assert(len == 1) passes
 833
 834         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 835         check_added_monitors!(nodes[0], 1);
 836         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 837
 838         expect_pending_htlcs_forwardable!(nodes[0]);
 839
 840         let events = nodes[0].node.get_and_clear_pending_events();
 841         assert_eq!(events.len(), 1);
 842         match events[0] {
 843                 Event::PaymentClaimable { .. } => { },
 844                 _ => panic!("Unexpected event"),
 845         };
 846
 847         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
 848
 849         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
 850         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
 851         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 852         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
 853         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
 854 }
 855
 856 #[test]
 857 fn test_update_fee() {
 858         let chanmon_cfgs = create_chanmon_cfgs(2);
 859         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 860         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 861         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 862         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 863         let channel_id = chan.2;
 864
 865         // A                                        B
 866         // (1) update_fee/commitment_signed      ->
 867         //                                       <- (2) revoke_and_ack
 868         //                                       .- send (3) commitment_signed
 869         // (4) update_fee/commitment_signed      ->
 870         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 871         //                                       <- (3) commitment_signed delivered
 872         // send (6) revoke_and_ack               -.
 873         //                                       <- (5) deliver revoke_and_ack
 874         // (6) deliver revoke_and_ack            ->
 875         //                                       .- send (7) commitment_signed in response to (4)
 876         //                                       <- (7) deliver commitment_signed
 877         // revoke_and_ack                        ->
 878
 879         // Create and deliver (1)...
 880         let feerate;
 881         {
 882                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 883                 feerate = *feerate_lock;
 884                 *feerate_lock = feerate + 20;
 885         }
 886         nodes[0].node.timer_tick_occurred();
 887         check_added_monitors!(nodes[0], 1);
 888
 889         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 890         assert_eq!(events_0.len(), 1);
 891         let (update_msg, commitment_signed) = match events_0[0] {
 892                         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 } } => {
 893                         (update_fee.as_ref(), commitment_signed)
 894                 },
 895                 _ => panic!("Unexpected event"),
 896         };
 897         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 898
 899         // Generate (2) and (3):
 900         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 901         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 902         check_added_monitors!(nodes[1], 1);
 903
 904         // Deliver (2):
 905         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 906         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 907         check_added_monitors!(nodes[0], 1);
 908
 909         // Create and deliver (4)...
 910         {
 911                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 912                 *feerate_lock = feerate + 30;
 913         }
 914         nodes[0].node.timer_tick_occurred();
 915         check_added_monitors!(nodes[0], 1);
 916         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 917         assert_eq!(events_0.len(), 1);
 918         let (update_msg, commitment_signed) = match events_0[0] {
 919                         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 } } => {
 920                         (update_fee.as_ref(), commitment_signed)
 921                 },
 922                 _ => panic!("Unexpected event"),
 923         };
 924
 925         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 926         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 927         check_added_monitors!(nodes[1], 1);
 928         // ... creating (5)
 929         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 930         // No commitment_signed so get_event_msg's assert(len == 1) passes
 931
 932         // Handle (3), creating (6):
 933         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 934         check_added_monitors!(nodes[0], 1);
 935         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 936         // No commitment_signed so get_event_msg's assert(len == 1) passes
 937
 938         // Deliver (5):
 939         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 940         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 941         check_added_monitors!(nodes[0], 1);
 942
 943         // Deliver (6), creating (7):
 944         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 945         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 946         assert!(commitment_update.update_add_htlcs.is_empty());
 947         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 948         assert!(commitment_update.update_fail_htlcs.is_empty());
 949         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 950         assert!(commitment_update.update_fee.is_none());
 951         check_added_monitors!(nodes[1], 1);
 952
 953         // Deliver (7)
 954         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 955         check_added_monitors!(nodes[0], 1);
 956         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 957         // No commitment_signed so get_event_msg's assert(len == 1) passes
 958
 959         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 960         check_added_monitors!(nodes[1], 1);
 961         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 962
 963         assert_eq!(get_feerate!(nodes[0], nodes[1], channel_id), feerate + 30);
 964         assert_eq!(get_feerate!(nodes[1], nodes[0], channel_id), feerate + 30);
 965         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 966         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
 967         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
 968 }
 969
 970 #[test]
 971 fn fake_network_test() {
 972         // Simple test which builds a network of ChannelManagers, connects them to each other, and
 973         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
 974         let chanmon_cfgs = create_chanmon_cfgs(4);
 975         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
 976         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
 977         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
 978
 979         // Create some initial channels
 980         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
 981         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
 982         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
 983
 984         // Rebalance the network a bit by relaying one payment through all the channels...
 985         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
 986         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
 987         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
 988         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
 989
 990         // Send some more payments
 991         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
 992         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
 993         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
 994
 995         // Test failure packets
 996         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
 997         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
 998
 999         // Add a new channel that skips 3
1000         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3);
1001
1002         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
1003         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
1004         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1005         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1006         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1007         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1008         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1009
1010         // Do some rebalance loop payments, simultaneously
1011         let mut hops = Vec::with_capacity(3);
1012         hops.push(RouteHop {
1013                 pubkey: nodes[2].node.get_our_node_id(),
1014                 node_features: NodeFeatures::empty(),
1015                 short_channel_id: chan_2.0.contents.short_channel_id,
1016                 channel_features: ChannelFeatures::empty(),
1017                 fee_msat: 0,
1018                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1019         });
1020         hops.push(RouteHop {
1021                 pubkey: nodes[3].node.get_our_node_id(),
1022                 node_features: NodeFeatures::empty(),
1023                 short_channel_id: chan_3.0.contents.short_channel_id,
1024                 channel_features: ChannelFeatures::empty(),
1025                 fee_msat: 0,
1026                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1027         });
1028         hops.push(RouteHop {
1029                 pubkey: nodes[1].node.get_our_node_id(),
1030                 node_features: nodes[1].node.node_features(),
1031                 short_channel_id: chan_4.0.contents.short_channel_id,
1032                 channel_features: nodes[1].node.channel_features(),
1033                 fee_msat: 1000000,
1034                 cltv_expiry_delta: TEST_FINAL_CLTV,
1035         });
1036         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;
1037         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;
1038         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops], payment_params: None }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1039
1040         let mut hops = Vec::with_capacity(3);
1041         hops.push(RouteHop {
1042                 pubkey: nodes[3].node.get_our_node_id(),
1043                 node_features: NodeFeatures::empty(),
1044                 short_channel_id: chan_4.0.contents.short_channel_id,
1045                 channel_features: ChannelFeatures::empty(),
1046                 fee_msat: 0,
1047                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1048         });
1049         hops.push(RouteHop {
1050                 pubkey: nodes[2].node.get_our_node_id(),
1051                 node_features: NodeFeatures::empty(),
1052                 short_channel_id: chan_3.0.contents.short_channel_id,
1053                 channel_features: ChannelFeatures::empty(),
1054                 fee_msat: 0,
1055                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1056         });
1057         hops.push(RouteHop {
1058                 pubkey: nodes[1].node.get_our_node_id(),
1059                 node_features: nodes[1].node.node_features(),
1060                 short_channel_id: chan_2.0.contents.short_channel_id,
1061                 channel_features: nodes[1].node.channel_features(),
1062                 fee_msat: 1000000,
1063                 cltv_expiry_delta: TEST_FINAL_CLTV,
1064         });
1065         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;
1066         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;
1067         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops], payment_params: None }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1068
1069         // Claim the rebalances...
1070         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1071         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
1072
1073         // Close down the channels...
1074         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1075         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
1076         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
1077         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1078         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
1079         check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
1080         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1081         check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
1082         check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure);
1083         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1084         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
1085         check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure);
1086 }
1087
1088 #[test]
1089 fn holding_cell_htlc_counting() {
1090         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1091         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1092         // commitment dance rounds.
1093         let chanmon_cfgs = create_chanmon_cfgs(3);
1094         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1095         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1096         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1097         create_announced_chan_between_nodes(&nodes, 0, 1);
1098         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
1099
1100         let mut payments = Vec::new();
1101         for _ in 0..crate::ln::channel::OUR_MAX_HTLCS {
1102                 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[2], 100000);
1103                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
1104                 payments.push((payment_preimage, payment_hash));
1105         }
1106         check_added_monitors!(nodes[1], 1);
1107
1108         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1109         assert_eq!(events.len(), 1);
1110         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1111         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1112
1113         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1114         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1115         // another HTLC.
1116         let (route, payment_hash_1, _, payment_secret_1) = get_route_and_payment_hash!(nodes[1], nodes[2], 100000);
1117         {
1118                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)), true, APIError::ChannelUnavailable { ref err },
1119                         assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1120                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1121                 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1122         }
1123
1124         // This should also be true if we try to forward a payment.
1125         let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[2], 100000);
1126         {
1127                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1128                 check_added_monitors!(nodes[0], 1);
1129         }
1130
1131         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1132         assert_eq!(events.len(), 1);
1133         let payment_event = SendEvent::from_event(events.pop().unwrap());
1134         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1135
1136         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1137         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1138         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1139         // fails), the second will process the resulting failure and fail the HTLC backward.
1140         expect_pending_htlcs_forwardable!(nodes[1]);
1141         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
1142         check_added_monitors!(nodes[1], 1);
1143
1144         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1145         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1146         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1147
1148         expect_payment_failed_with_update!(nodes[0], payment_hash_2, false, chan_2.0.contents.short_channel_id, false);
1149
1150         // Now forward all the pending HTLCs and claim them back
1151         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1152         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1153         check_added_monitors!(nodes[2], 1);
1154
1155         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1156         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1157         check_added_monitors!(nodes[1], 1);
1158         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1159
1160         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1161         check_added_monitors!(nodes[1], 1);
1162         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1163
1164         for ref update in as_updates.update_add_htlcs.iter() {
1165                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1166         }
1167         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1168         check_added_monitors!(nodes[2], 1);
1169         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1170         check_added_monitors!(nodes[2], 1);
1171         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1172
1173         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1174         check_added_monitors!(nodes[1], 1);
1175         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1176         check_added_monitors!(nodes[1], 1);
1177         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1178
1179         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1180         check_added_monitors!(nodes[2], 1);
1181
1182         expect_pending_htlcs_forwardable!(nodes[2]);
1183
1184         let events = nodes[2].node.get_and_clear_pending_events();
1185         assert_eq!(events.len(), payments.len());
1186         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1187                 match event {
1188                         &Event::PaymentClaimable { ref payment_hash, .. } => {
1189                                 assert_eq!(*payment_hash, *hash);
1190                         },
1191                         _ => panic!("Unexpected event"),
1192                 };
1193         }
1194
1195         for (preimage, _) in payments.drain(..) {
1196                 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1197         }
1198
1199         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1200 }
1201
1202 #[test]
1203 fn duplicate_htlc_test() {
1204         // Test that we accept duplicate payment_hash HTLCs across the network and that
1205         // claiming/failing them are all separate and don't affect each other
1206         let chanmon_cfgs = create_chanmon_cfgs(6);
1207         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1208         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1209         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1210
1211         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1212         create_announced_chan_between_nodes(&nodes, 0, 3);
1213         create_announced_chan_between_nodes(&nodes, 1, 3);
1214         create_announced_chan_between_nodes(&nodes, 2, 3);
1215         create_announced_chan_between_nodes(&nodes, 3, 4);
1216         create_announced_chan_between_nodes(&nodes, 3, 5);
1217
1218         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1219
1220         *nodes[0].network_payment_count.borrow_mut() -= 1;
1221         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1222
1223         *nodes[0].network_payment_count.borrow_mut() -= 1;
1224         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1225
1226         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1227         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1228         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1229 }
1230
1231 #[test]
1232 fn test_duplicate_htlc_different_direction_onchain() {
1233         // Test that ChannelMonitor doesn't generate 2 preimage txn
1234         // when we have 2 HTLCs with same preimage that go across a node
1235         // in opposite directions, even with the same payment secret.
1236         let chanmon_cfgs = create_chanmon_cfgs(2);
1237         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1238         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1239         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1240
1241         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1242
1243         // balancing
1244         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1245
1246         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1247
1248         let (route, _, _, _) = get_route_and_payment_hash!(nodes[1], nodes[0], 800_000);
1249         let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();
1250         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1251
1252         // Provide preimage to node 0 by claiming payment
1253         nodes[0].node.claim_funds(payment_preimage);
1254         expect_payment_claimed!(nodes[0], payment_hash, 800_000);
1255         check_added_monitors!(nodes[0], 1);
1256
1257         // Broadcast node 1 commitment txn
1258         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1259
1260         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1261         let mut has_both_htlcs = 0; // check htlcs match ones committed
1262         for outp in remote_txn[0].output.iter() {
1263                 if outp.value == 800_000 / 1000 {
1264                         has_both_htlcs += 1;
1265                 } else if outp.value == 900_000 / 1000 {
1266                         has_both_htlcs += 1;
1267                 }
1268         }
1269         assert_eq!(has_both_htlcs, 2);
1270
1271         mine_transaction(&nodes[0], &remote_txn[0]);
1272         check_added_monitors!(nodes[0], 1);
1273         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
1274         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
1275
1276         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1277         assert_eq!(claim_txn.len(), 3);
1278
1279         check_spends!(claim_txn[0], remote_txn[0]); // Immediate HTLC claim with preimage
1280         check_spends!(claim_txn[1], remote_txn[0]);
1281         check_spends!(claim_txn[2], remote_txn[0]);
1282         let preimage_tx = &claim_txn[0];
1283         let (preimage_bump_tx, timeout_tx) = if claim_txn[1].input[0].previous_output == preimage_tx.input[0].previous_output {
1284                 (&claim_txn[1], &claim_txn[2])
1285         } else {
1286                 (&claim_txn[2], &claim_txn[1])
1287         };
1288
1289         assert_eq!(preimage_tx.input.len(), 1);
1290         assert_eq!(preimage_bump_tx.input.len(), 1);
1291
1292         assert_eq!(preimage_tx.input.len(), 1);
1293         assert_eq!(preimage_tx.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1294         assert_eq!(remote_txn[0].output[preimage_tx.input[0].previous_output.vout as usize].value, 800);
1295
1296         assert_eq!(timeout_tx.input.len(), 1);
1297         assert_eq!(timeout_tx.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1298         check_spends!(timeout_tx, remote_txn[0]);
1299         assert_eq!(remote_txn[0].output[timeout_tx.input[0].previous_output.vout as usize].value, 900);
1300
1301         let events = nodes[0].node.get_and_clear_pending_msg_events();
1302         assert_eq!(events.len(), 3);
1303         for e in events {
1304                 match e {
1305                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1306                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1307                                 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1308                                 assert_eq!(msg.data, "Channel closed because commitment or closing transaction was confirmed on chain.");
1309                         },
1310                         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, .. } } => {
1311                                 assert!(update_add_htlcs.is_empty());
1312                                 assert!(update_fail_htlcs.is_empty());
1313                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1314                                 assert!(update_fail_malformed_htlcs.is_empty());
1315                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1316                         },
1317                         _ => panic!("Unexpected event"),
1318                 }
1319         }
1320 }
1321
1322 #[test]
1323 fn test_basic_channel_reserve() {
1324         let chanmon_cfgs = create_chanmon_cfgs(2);
1325         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1326         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1327         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1328         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
1329
1330         let chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
1331         let channel_reserve = chan_stat.channel_reserve_msat;
1332
1333         // The 2* and +1 are for the fee spike reserve.
1334         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], nodes[1], chan.2), 1 + 1, get_opt_anchors!(nodes[0], nodes[1], chan.2));
1335         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1336         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], max_can_send + 1);
1337         let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).err().unwrap();
1338         match err {
1339                 PaymentSendFailure::AllFailedResendSafe(ref fails) => {
1340                         match &fails[0] {
1341                                 &APIError::ChannelUnavailable{ref err} =>
1342                                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1343                                 _ => panic!("Unexpected error variant"),
1344                         }
1345                 },
1346                 _ => panic!("Unexpected error variant"),
1347         }
1348         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1349         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);
1350
1351         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1352 }
1353
1354 #[test]
1355 fn test_fee_spike_violation_fails_htlc() {
1356         let chanmon_cfgs = create_chanmon_cfgs(2);
1357         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1358         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1359         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1360         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
1361
1362         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1363         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1364         let secp_ctx = Secp256k1::new();
1365         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1366
1367         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1368
1369         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1370         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height, &None).unwrap();
1371         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1372         let msg = msgs::UpdateAddHTLC {
1373                 channel_id: chan.2,
1374                 htlc_id: 0,
1375                 amount_msat: htlc_msat,
1376                 payment_hash: payment_hash,
1377                 cltv_expiry: htlc_cltv,
1378                 onion_routing_packet: onion_packet,
1379         };
1380
1381         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1382
1383         // Now manually create the commitment_signed message corresponding to the update_add
1384         // nodes[0] just sent. In the code for construction of this message, "local" refers
1385         // to the sender of the message, and "remote" refers to the receiver.
1386
1387         let feerate_per_kw = get_feerate!(nodes[0], nodes[1], chan.2);
1388
1389         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1390
1391         // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1392         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1393         let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point, local_funding) = {
1394                 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
1395                 let chan_lock = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
1396                 let local_chan = chan_lock.channel_by_id.get(&chan.2).unwrap();
1397                 let chan_signer = local_chan.get_signer();
1398                 // Make the signer believe we validated another commitment, so we can release the secret
1399                 chan_signer.get_enforcement_state().last_holder_commitment -= 1;
1400
1401                 let pubkeys = chan_signer.pubkeys();
1402                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1403                  chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1404                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx),
1405                  chan_signer.pubkeys().funding_pubkey)
1406         };
1407         let (remote_delayed_payment_basepoint, remote_htlc_basepoint, remote_point, remote_funding) = {
1408                 let per_peer_state = nodes[1].node.per_peer_state.read().unwrap();
1409                 let chan_lock = per_peer_state.get(&nodes[0].node.get_our_node_id()).unwrap().lock().unwrap();
1410                 let remote_chan = chan_lock.channel_by_id.get(&chan.2).unwrap();
1411                 let chan_signer = remote_chan.get_signer();
1412                 let pubkeys = chan_signer.pubkeys();
1413                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1414                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx),
1415                  chan_signer.pubkeys().funding_pubkey)
1416         };
1417
1418         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1419         let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1420                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint);
1421
1422         // Build the remote commitment transaction so we can sign it, and then later use the
1423         // signature for the commitment_signed message.
1424         let local_chan_balance = 1313;
1425
1426         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1427                 offered: false,
1428                 amount_msat: 3460001,
1429                 cltv_expiry: htlc_cltv,
1430                 payment_hash,
1431                 transaction_output_index: Some(1),
1432         };
1433
1434         let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1435
1436         let res = {
1437                 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
1438                 let local_chan_lock = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
1439                 let local_chan = local_chan_lock.channel_by_id.get(&chan.2).unwrap();
1440                 let local_chan_signer = local_chan.get_signer();
1441                 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1442                         commitment_number,
1443                         95000,
1444                         local_chan_balance,
1445                         local_chan.opt_anchors(), local_funding, remote_funding,
1446                         commit_tx_keys.clone(),
1447                         feerate_per_kw,
1448                         &mut vec![(accepted_htlc_info, ())],
1449                         &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1450                 );
1451                 local_chan_signer.sign_counterparty_commitment(&commitment_tx, Vec::new(), &secp_ctx).unwrap()
1452         };
1453
1454         let commit_signed_msg = msgs::CommitmentSigned {
1455                 channel_id: chan.2,
1456                 signature: res.0,
1457                 htlc_signatures: res.1
1458         };
1459
1460         // Send the commitment_signed message to the nodes[1].
1461         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1462         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1463
1464         // Send the RAA to nodes[1].
1465         let raa_msg = msgs::RevokeAndACK {
1466                 channel_id: chan.2,
1467                 per_commitment_secret: local_secret,
1468                 next_per_commitment_point: next_local_point
1469         };
1470         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1471
1472         let events = nodes[1].node.get_and_clear_pending_msg_events();
1473         assert_eq!(events.len(), 1);
1474         // Make sure the HTLC failed in the way we expect.
1475         match events[0] {
1476                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1477                         assert_eq!(update_fail_htlcs.len(), 1);
1478                         update_fail_htlcs[0].clone()
1479                 },
1480                 _ => panic!("Unexpected event"),
1481         };
1482         nodes[1].logger.assert_log("lightning::ln::channel".to_string(),
1483                 format!("Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", ::hex::encode(raa_msg.channel_id)), 1);
1484
1485         check_added_monitors!(nodes[1], 2);
1486 }
1487
1488 #[test]
1489 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1490         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1491         // Set the fee rate for the channel very high, to the point where the fundee
1492         // sending any above-dust amount would result in a channel reserve violation.
1493         // In this test we check that we would be prevented from sending an HTLC in
1494         // this situation.
1495         let feerate_per_kw = *chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1496         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1497         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1498         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1499         let default_config = UserConfig::default();
1500         let opt_anchors = false;
1501
1502         let mut push_amt = 100_000_000;
1503         push_amt -= commit_tx_fee_msat(feerate_per_kw, MIN_AFFORDABLE_HTLC_COUNT as u64, opt_anchors);
1504
1505         push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000, &default_config) * 1000;
1506
1507         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, push_amt);
1508
1509         // Sending exactly enough to hit the reserve amount should be accepted
1510         for _ in 0..MIN_AFFORDABLE_HTLC_COUNT {
1511                 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], 1_000_000);
1512         }
1513
1514         // However one more HTLC should be significantly over the reserve amount and fail.
1515         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1_000_000);
1516         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
1517                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1518         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1519         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);
1520 }
1521
1522 #[test]
1523 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1524         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1525         let feerate_per_kw = *chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1526         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1527         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1528         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1529         let default_config = UserConfig::default();
1530         let opt_anchors = false;
1531
1532         // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1533         // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1534         // transaction fee with 0 HTLCs (183 sats)).
1535         let mut push_amt = 100_000_000;
1536         push_amt -= commit_tx_fee_msat(feerate_per_kw, MIN_AFFORDABLE_HTLC_COUNT as u64, opt_anchors);
1537         push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000, &default_config) * 1000;
1538         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, push_amt);
1539
1540         // Send four HTLCs to cover the initial push_msat buffer we're required to include
1541         for _ in 0..MIN_AFFORDABLE_HTLC_COUNT {
1542                 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], 1_000_000);
1543         }
1544
1545         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 700_000);
1546         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1547         let secp_ctx = Secp256k1::new();
1548         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1549         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1550         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1551         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 700_000, &Some(payment_secret), cur_height, &None).unwrap();
1552         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1553         let msg = msgs::UpdateAddHTLC {
1554                 channel_id: chan.2,
1555                 htlc_id: MIN_AFFORDABLE_HTLC_COUNT as u64,
1556                 amount_msat: htlc_msat,
1557                 payment_hash: payment_hash,
1558                 cltv_expiry: htlc_cltv,
1559                 onion_routing_packet: onion_packet,
1560         };
1561
1562         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1563         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1564         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);
1565         assert_eq!(nodes[0].node.list_channels().len(), 0);
1566         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1567         assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1568         check_added_monitors!(nodes[0], 1);
1569         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_string() });
1570 }
1571
1572 #[test]
1573 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1574         // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1575         // calculating our commitment transaction fee (this was previously broken).
1576         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1577         let feerate_per_kw = *chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1578
1579         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1580         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1581         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1582         let default_config = UserConfig::default();
1583         let opt_anchors = false;
1584
1585         // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1586         // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1587         // transaction fee with 0 HTLCs (183 sats)).
1588         let mut push_amt = 100_000_000;
1589         push_amt -= commit_tx_fee_msat(feerate_per_kw, MIN_AFFORDABLE_HTLC_COUNT as u64, opt_anchors);
1590         push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000, &default_config) * 1000;
1591         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, push_amt);
1592
1593         let dust_amt = crate::ln::channel::MIN_CHAN_DUST_LIMIT_SATOSHIS * 1000
1594                 + feerate_per_kw as u64 * htlc_success_tx_weight(opt_anchors) / 1000 * 1000 - 1;
1595         // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1596         // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1597         // commitment transaction fee.
1598         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1599
1600         // Send four HTLCs to cover the initial push_msat buffer we're required to include
1601         for _ in 0..MIN_AFFORDABLE_HTLC_COUNT {
1602                 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], 1_000_000);
1603         }
1604
1605         // One more than the dust amt should fail, however.
1606         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], dust_amt + 1);
1607         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
1608                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1609 }
1610
1611 #[test]
1612 fn test_chan_init_feerate_unaffordability() {
1613         // Test that we will reject channel opens which do not leave enough to pay for any HTLCs due to
1614         // channel reserve and feerate requirements.
1615         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1616         let feerate_per_kw = *chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1617         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1618         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1619         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1620         let default_config = UserConfig::default();
1621         let opt_anchors = false;
1622
1623         // Set the push_msat amount such that nodes[0] will not be able to afford to add even a single
1624         // HTLC.
1625         let mut push_amt = 100_000_000;
1626         push_amt -= commit_tx_fee_msat(feerate_per_kw, MIN_AFFORDABLE_HTLC_COUNT as u64, opt_anchors);
1627         assert_eq!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, push_amt + 1, 42, None).unwrap_err(),
1628                 APIError::APIMisuseError { err: "Funding amount (356) can't even pay fee for initial commitment transaction fee of 357.".to_string() });
1629
1630         // During open, we don't have a "counterparty channel reserve" to check against, so that
1631         // requirement only comes into play on the open_channel handling side.
1632         push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000, &default_config) * 1000;
1633         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, push_amt, 42, None).unwrap();
1634         let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
1635         open_channel_msg.push_msat += 1;
1636         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
1637
1638         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1639         assert_eq!(msg_events.len(), 1);
1640         match msg_events[0] {
1641                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1642                         assert_eq!(msg.data, "Insufficient funding amount for initial reserve");
1643                 },
1644                 _ => panic!("Unexpected event"),
1645         }
1646 }
1647
1648 #[test]
1649 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1650         // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1651         // calculating our counterparty's commitment transaction fee (this was previously broken).
1652         let chanmon_cfgs = create_chanmon_cfgs(2);
1653         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1654         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1655         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1656         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000);
1657
1658         let payment_amt = 46000; // Dust amount
1659         // In the previous code, these first four payments would succeed.
1660         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1661         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1662         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1663         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1664
1665         // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1666         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1667         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1668         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1669         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1670         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1671
1672         // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1673         // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1674         // transaction fee and therefore perceived this next payment as a channel reserve violation.
1675         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1676 }
1677
1678 #[test]
1679 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1680         let chanmon_cfgs = create_chanmon_cfgs(3);
1681         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1682         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1683         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1684         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
1685         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000);
1686
1687         let feemsat = 239;
1688         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1689         let chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
1690         let feerate = get_feerate!(nodes[0], nodes[1], chan.2);
1691         let opt_anchors = get_opt_anchors!(nodes[0], nodes[1], chan.2);
1692
1693         // Add a 2* and +1 for the fee spike reserve.
1694         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1, opt_anchors);
1695         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;
1696         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1697
1698         // Add a pending HTLC.
1699         let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1700         let payment_event_1 = {
1701                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1), PaymentId(our_payment_hash_1.0)).unwrap();
1702                 check_added_monitors!(nodes[0], 1);
1703
1704                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1705                 assert_eq!(events.len(), 1);
1706                 SendEvent::from_event(events.remove(0))
1707         };
1708         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1709
1710         // Attempt to trigger a channel reserve violation --> payment failure.
1711         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2, opt_anchors);
1712         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;
1713         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1714         let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1715
1716         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1717         let secp_ctx = Secp256k1::new();
1718         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1719         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1720         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1721         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height, &None).unwrap();
1722         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1723         let msg = msgs::UpdateAddHTLC {
1724                 channel_id: chan.2,
1725                 htlc_id: 1,
1726                 amount_msat: htlc_msat + 1,
1727                 payment_hash: our_payment_hash_1,
1728                 cltv_expiry: htlc_cltv,
1729                 onion_routing_packet: onion_packet,
1730         };
1731
1732         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1733         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1734         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1735         assert_eq!(nodes[1].node.list_channels().len(), 1);
1736         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1737         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1738         check_added_monitors!(nodes[1], 1);
1739         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Remote HTLC add would put them under remote reserve value".to_string() });
1740 }
1741
1742 #[test]
1743 fn test_inbound_outbound_capacity_is_not_zero() {
1744         let chanmon_cfgs = create_chanmon_cfgs(2);
1745         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1746         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1747         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1748         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
1749         let channels0 = node_chanmgrs[0].list_channels();
1750         let channels1 = node_chanmgrs[1].list_channels();
1751         let default_config = UserConfig::default();
1752         assert_eq!(channels0.len(), 1);
1753         assert_eq!(channels1.len(), 1);
1754
1755         let reserve = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000, &default_config);
1756         assert_eq!(channels0[0].inbound_capacity_msat, 95000000 - reserve*1000);
1757         assert_eq!(channels1[0].outbound_capacity_msat, 95000000 - reserve*1000);
1758
1759         assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1760         assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1761 }
1762
1763 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64, opt_anchors: bool) -> u64 {
1764         (commitment_tx_base_weight(opt_anchors) + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1765 }
1766
1767 #[test]
1768 fn test_channel_reserve_holding_cell_htlcs() {
1769         let chanmon_cfgs = create_chanmon_cfgs(3);
1770         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1771         // When this test was written, the default base fee floated based on the HTLC count.
1772         // It is now fixed, so we simply set the fee to the expected value here.
1773         let mut config = test_default_channel_config();
1774         config.channel_config.forwarding_fee_base_msat = 239;
1775         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
1776         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1777         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001);
1778         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001);
1779
1780         let mut stat01 = get_channel_value_stat!(nodes[0], nodes[1], chan_1.2);
1781         let mut stat11 = get_channel_value_stat!(nodes[1], nodes[0], chan_1.2);
1782
1783         let mut stat12 = get_channel_value_stat!(nodes[1], nodes[2], chan_2.2);
1784         let mut stat22 = get_channel_value_stat!(nodes[2], nodes[1], chan_2.2);
1785
1786         macro_rules! expect_forward {
1787                 ($node: expr) => {{
1788                         let mut events = $node.node.get_and_clear_pending_msg_events();
1789                         assert_eq!(events.len(), 1);
1790                         check_added_monitors!($node, 1);
1791                         let payment_event = SendEvent::from_event(events.remove(0));
1792                         payment_event
1793                 }}
1794         }
1795
1796         let feemsat = 239; // set above
1797         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1798         let feerate = get_feerate!(nodes[0], nodes[1], chan_1.2);
1799         let opt_anchors = get_opt_anchors!(nodes[0], nodes[1], chan_1.2);
1800
1801         let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1802
1803         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1804         {
1805                 let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV)
1806                         .with_features(nodes[2].node.invoice_features()).with_max_channel_saturation_power_of_half(0);
1807                 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, recv_value_0, TEST_FINAL_CLTV);
1808                 route.paths[0].last_mut().unwrap().fee_msat += 1;
1809                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1810
1811                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
1812                         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)));
1813                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1814                 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);
1815         }
1816
1817         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1818         // nodes[0]'s wealth
1819         loop {
1820                 let amt_msat = recv_value_0 + total_fee_msat;
1821                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1822                 // Also, ensure that each payment has enough to be over the dust limit to
1823                 // ensure it'll be included in each commit tx fee calculation.
1824                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1, opt_anchors);
1825                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1826                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1827                         break;
1828                 }
1829
1830                 let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV)
1831                         .with_features(nodes[2].node.invoice_features()).with_max_channel_saturation_power_of_half(0);
1832                 let route = get_route!(nodes[0], payment_params, recv_value_0, TEST_FINAL_CLTV).unwrap();
1833                 let (payment_preimage, ..) = send_along_route(&nodes[0], route, &[&nodes[1], &nodes[2]], recv_value_0);
1834                 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
1835
1836                 let (stat01_, stat11_, stat12_, stat22_) = (
1837                         get_channel_value_stat!(nodes[0], nodes[1], chan_1.2),
1838                         get_channel_value_stat!(nodes[1], nodes[0], chan_1.2),
1839                         get_channel_value_stat!(nodes[1], nodes[2], chan_2.2),
1840                         get_channel_value_stat!(nodes[2], nodes[1], chan_2.2),
1841                 );
1842
1843                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1844                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1845                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1846                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1847                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1848         }
1849
1850         // adding pending output.
1851         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1852         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1853         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1854         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1855         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1856         // cases where 1 msat over X amount will cause a payment failure, but anything less than
1857         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1858         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1859         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1860         // policy.
1861         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1, opt_anchors);
1862         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1863         let amt_msat_1 = recv_value_1 + total_fee_msat;
1864
1865         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);
1866         let payment_event_1 = {
1867                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1), PaymentId(our_payment_hash_1.0)).unwrap();
1868                 check_added_monitors!(nodes[0], 1);
1869
1870                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1871                 assert_eq!(events.len(), 1);
1872                 SendEvent::from_event(events.remove(0))
1873         };
1874         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1875
1876         // channel reserve test with htlc pending output > 0
1877         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1878         {
1879                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
1880                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
1881                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1882                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1883         }
1884
1885         // split the rest to test holding cell
1886         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1, opt_anchors);
1887         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
1888         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
1889         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
1890         {
1891                 let stat = get_channel_value_stat!(nodes[0], nodes[1], chan_1.2);
1892                 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);
1893         }
1894
1895         // now see if they go through on both sides
1896         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);
1897         // but this will stuck in the holding cell
1898         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21), PaymentId(our_payment_hash_21.0)).unwrap();
1899         check_added_monitors!(nodes[0], 0);
1900         let events = nodes[0].node.get_and_clear_pending_events();
1901         assert_eq!(events.len(), 0);
1902
1903         // test with outbound holding cell amount > 0
1904         {
1905                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
1906                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
1907                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1908                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1909                 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);
1910         }
1911
1912         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);
1913         // this will also stuck in the holding cell
1914         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22), PaymentId(our_payment_hash_22.0)).unwrap();
1915         check_added_monitors!(nodes[0], 0);
1916         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1917         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1918
1919         // flush the pending htlc
1920         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1921         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1922         check_added_monitors!(nodes[1], 1);
1923
1924         // the pending htlc should be promoted to committed
1925         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1926         check_added_monitors!(nodes[0], 1);
1927         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1928
1929         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1930         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1931         // No commitment_signed so get_event_msg's assert(len == 1) passes
1932         check_added_monitors!(nodes[0], 1);
1933
1934         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1935         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1936         check_added_monitors!(nodes[1], 1);
1937
1938         expect_pending_htlcs_forwardable!(nodes[1]);
1939
1940         let ref payment_event_11 = expect_forward!(nodes[1]);
1941         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1942         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1943
1944         expect_pending_htlcs_forwardable!(nodes[2]);
1945         expect_payment_claimable!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
1946
1947         // flush the htlcs in the holding cell
1948         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1949         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1950         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1951         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1952         expect_pending_htlcs_forwardable!(nodes[1]);
1953
1954         let ref payment_event_3 = expect_forward!(nodes[1]);
1955         assert_eq!(payment_event_3.msgs.len(), 2);
1956         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1957         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1958
1959         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1960         expect_pending_htlcs_forwardable!(nodes[2]);
1961
1962         let events = nodes[2].node.get_and_clear_pending_events();
1963         assert_eq!(events.len(), 2);
1964         match events[0] {
1965                 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id: _ } => {
1966                         assert_eq!(our_payment_hash_21, *payment_hash);
1967                         assert_eq!(recv_value_21, amount_msat);
1968                         assert_eq!(nodes[2].node.get_our_node_id(), receiver_node_id.unwrap());
1969                         assert_eq!(via_channel_id, Some(chan_2.2));
1970                         match &purpose {
1971                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1972                                         assert!(payment_preimage.is_none());
1973                                         assert_eq!(our_payment_secret_21, *payment_secret);
1974                                 },
1975                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
1976                         }
1977                 },
1978                 _ => panic!("Unexpected event"),
1979         }
1980         match events[1] {
1981                 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id: _ } => {
1982                         assert_eq!(our_payment_hash_22, *payment_hash);
1983                         assert_eq!(recv_value_22, amount_msat);
1984                         assert_eq!(nodes[2].node.get_our_node_id(), receiver_node_id.unwrap());
1985                         assert_eq!(via_channel_id, Some(chan_2.2));
1986                         match &purpose {
1987                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1988                                         assert!(payment_preimage.is_none());
1989                                         assert_eq!(our_payment_secret_22, *payment_secret);
1990                                 },
1991                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
1992                         }
1993                 },
1994                 _ => panic!("Unexpected event"),
1995         }
1996
1997         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
1998         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
1999         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
2000
2001         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1, opt_anchors);
2002         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2003         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
2004
2005         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1, opt_anchors);
2006         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);
2007         let stat0 = get_channel_value_stat!(nodes[0], nodes[1], chan_1.2);
2008         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2009         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2010
2011         let stat2 = get_channel_value_stat!(nodes[2], nodes[1], chan_2.2);
2012         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2013 }
2014
2015 #[test]
2016 fn channel_reserve_in_flight_removes() {
2017         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2018         // can send to its counterparty, but due to update ordering, the other side may not yet have
2019         // considered those HTLCs fully removed.
2020         // This tests that we don't count HTLCs which will not be included in the next remote
2021         // commitment transaction towards the reserve value (as it implies no commitment transaction
2022         // will be generated which violates the remote reserve value).
2023         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2024         // To test this we:
2025         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2026         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2027         //    you only consider the value of the first HTLC, it may not),
2028         //  * start routing a third HTLC from A to B,
2029         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2030         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2031         //  * deliver the first fulfill from B
2032         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2033         //    claim,
2034         //  * deliver A's response CS and RAA.
2035         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2036         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
2037         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2038         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2039         let chanmon_cfgs = create_chanmon_cfgs(2);
2040         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2041         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2042         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2043         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2044
2045         let b_chan_values = get_channel_value_stat!(nodes[1], nodes[0], chan_1.2);
2046         // Route the first two HTLCs.
2047         let payment_value_1 = b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000;
2048         let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], payment_value_1);
2049         let (payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20_000);
2050
2051         // Start routing the third HTLC (this is just used to get everyone in the right state).
2052         let (route, payment_hash_3, payment_preimage_3, payment_secret_3) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
2053         let send_1 = {
2054                 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
2055                 check_added_monitors!(nodes[0], 1);
2056                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2057                 assert_eq!(events.len(), 1);
2058                 SendEvent::from_event(events.remove(0))
2059         };
2060
2061         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2062         // initial fulfill/CS.
2063         nodes[1].node.claim_funds(payment_preimage_1);
2064         expect_payment_claimed!(nodes[1], payment_hash_1, payment_value_1);
2065         check_added_monitors!(nodes[1], 1);
2066         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2067
2068         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2069         // remove the second HTLC when we send the HTLC back from B to A.
2070         nodes[1].node.claim_funds(payment_preimage_2);
2071         expect_payment_claimed!(nodes[1], payment_hash_2, 20_000);
2072         check_added_monitors!(nodes[1], 1);
2073         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2074
2075         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2076         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2077         check_added_monitors!(nodes[0], 1);
2078         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2079         expect_payment_sent_without_paths!(nodes[0], payment_preimage_1);
2080
2081         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2082         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2083         check_added_monitors!(nodes[1], 1);
2084         // B is already AwaitingRAA, so cant generate a CS here
2085         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2086
2087         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2088         check_added_monitors!(nodes[1], 1);
2089         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2090
2091         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2092         check_added_monitors!(nodes[0], 1);
2093         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2094
2095         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2096         check_added_monitors!(nodes[1], 1);
2097         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2098
2099         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2100         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2101         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2102         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2103         // on-chain as necessary).
2104         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2105         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2106         check_added_monitors!(nodes[0], 1);
2107         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2108         expect_payment_sent_without_paths!(nodes[0], payment_preimage_2);
2109
2110         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2111         check_added_monitors!(nodes[1], 1);
2112         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2113
2114         expect_pending_htlcs_forwardable!(nodes[1]);
2115         expect_payment_claimable!(nodes[1], payment_hash_3, payment_secret_3, 100000);
2116
2117         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2118         // resolve the second HTLC from A's point of view.
2119         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2120         check_added_monitors!(nodes[0], 1);
2121         expect_payment_path_successful!(nodes[0]);
2122         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2123
2124         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2125         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2126         let (route, payment_hash_4, payment_preimage_4, payment_secret_4) = get_route_and_payment_hash!(nodes[1], nodes[0], 10000);
2127         let send_2 = {
2128                 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4), PaymentId(payment_hash_4.0)).unwrap();
2129                 check_added_monitors!(nodes[1], 1);
2130                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2131                 assert_eq!(events.len(), 1);
2132                 SendEvent::from_event(events.remove(0))
2133         };
2134
2135         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2136         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2137         check_added_monitors!(nodes[0], 1);
2138         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2139
2140         // Now just resolve all the outstanding messages/HTLCs for completeness...
2141
2142         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2143         check_added_monitors!(nodes[1], 1);
2144         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2145
2146         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2147         check_added_monitors!(nodes[1], 1);
2148
2149         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2150         check_added_monitors!(nodes[0], 1);
2151         expect_payment_path_successful!(nodes[0]);
2152         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2153
2154         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2155         check_added_monitors!(nodes[1], 1);
2156         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2157
2158         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2159         check_added_monitors!(nodes[0], 1);
2160
2161         expect_pending_htlcs_forwardable!(nodes[0]);
2162         expect_payment_claimable!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2163
2164         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2165         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2166 }
2167
2168 #[test]
2169 fn channel_monitor_network_test() {
2170         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2171         // tests that ChannelMonitor is able to recover from various states.
2172         let chanmon_cfgs = create_chanmon_cfgs(5);
2173         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2174         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2175         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2176
2177         // Create some initial channels
2178         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2179         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2180         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
2181         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4);
2182
2183         // Make sure all nodes are at the same starting height
2184         connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2185         connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2186         connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2187         connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2188         connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2189
2190         // Rebalance the network a bit by relaying one payment through all the channels...
2191         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2192         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2193         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2194         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2195
2196         // Simple case with no pending HTLCs:
2197         nodes[1].node.force_close_broadcasting_latest_txn(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
2198         check_added_monitors!(nodes[1], 1);
2199         check_closed_broadcast!(nodes[1], true);
2200         {
2201                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2202                 assert_eq!(node_txn.len(), 1);
2203                 mine_transaction(&nodes[0], &node_txn[0]);
2204                 check_added_monitors!(nodes[0], 1);
2205                 test_txn_broadcast(&nodes[0], &chan_1, Some(node_txn[0].clone()), HTLCType::NONE);
2206         }
2207         check_closed_broadcast!(nodes[0], true);
2208         assert_eq!(nodes[0].node.list_channels().len(), 0);
2209         assert_eq!(nodes[1].node.list_channels().len(), 1);
2210         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2211         check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
2212
2213         // One pending HTLC is discarded by the force-close:
2214         let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[1], &[&nodes[2], &nodes[3]], 3_000_000);
2215
2216         // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2217         // broadcasted until we reach the timelock time).
2218         nodes[1].node.force_close_broadcasting_latest_txn(&chan_2.2, &nodes[2].node.get_our_node_id()).unwrap();
2219         check_closed_broadcast!(nodes[1], true);
2220         check_added_monitors!(nodes[1], 1);
2221         {
2222                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2223                 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2224                 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2225                 mine_transaction(&nodes[2], &node_txn[0]);
2226                 check_added_monitors!(nodes[2], 1);
2227                 test_txn_broadcast(&nodes[2], &chan_2, Some(node_txn[0].clone()), HTLCType::NONE);
2228         }
2229         check_closed_broadcast!(nodes[2], true);
2230         assert_eq!(nodes[1].node.list_channels().len(), 0);
2231         assert_eq!(nodes[2].node.list_channels().len(), 1);
2232         check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
2233         check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
2234
2235         macro_rules! claim_funds {
2236                 ($node: expr, $prev_node: expr, $preimage: expr, $payment_hash: expr) => {
2237                         {
2238                                 $node.node.claim_funds($preimage);
2239                                 expect_payment_claimed!($node, $payment_hash, 3_000_000);
2240                                 check_added_monitors!($node, 1);
2241
2242                                 let events = $node.node.get_and_clear_pending_msg_events();
2243                                 assert_eq!(events.len(), 1);
2244                                 match events[0] {
2245                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2246                                                 assert!(update_add_htlcs.is_empty());
2247                                                 assert!(update_fail_htlcs.is_empty());
2248                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2249                                         },
2250                                         _ => panic!("Unexpected event"),
2251                                 };
2252                         }
2253                 }
2254         }
2255
2256         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2257         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2258         nodes[2].node.force_close_broadcasting_latest_txn(&chan_3.2, &nodes[3].node.get_our_node_id()).unwrap();
2259         check_added_monitors!(nodes[2], 1);
2260         check_closed_broadcast!(nodes[2], true);
2261         let node2_commitment_txid;
2262         {
2263                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2264                 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2265                 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2266                 node2_commitment_txid = node_txn[0].txid();
2267
2268                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2269                 claim_funds!(nodes[3], nodes[2], payment_preimage_1, payment_hash_1);
2270                 mine_transaction(&nodes[3], &node_txn[0]);
2271                 check_added_monitors!(nodes[3], 1);
2272                 check_preimage_claim(&nodes[3], &node_txn);
2273         }
2274         check_closed_broadcast!(nodes[3], true);
2275         assert_eq!(nodes[2].node.list_channels().len(), 0);
2276         assert_eq!(nodes[3].node.list_channels().len(), 1);
2277         check_closed_event!(nodes[2], 1, ClosureReason::HolderForceClosed);
2278         check_closed_event!(nodes[3], 1, ClosureReason::CommitmentTxConfirmed);
2279
2280         // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2281         // confusing us in the following tests.
2282         let chan_3_mon = nodes[3].chain_monitor.chain_monitor.remove_monitor(&OutPoint { txid: chan_3.3.txid(), index: 0 });
2283
2284         // One pending HTLC to time out:
2285         let (payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[3], &[&nodes[4]], 3_000_000);
2286         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2287         // buffer space).
2288
2289         let (close_chan_update_1, close_chan_update_2) = {
2290                 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2291                 let events = nodes[3].node.get_and_clear_pending_msg_events();
2292                 assert_eq!(events.len(), 2);
2293                 let close_chan_update_1 = match events[0] {
2294                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2295                                 msg.clone()
2296                         },
2297                         _ => panic!("Unexpected event"),
2298                 };
2299                 match events[1] {
2300                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2301                                 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2302                         },
2303                         _ => panic!("Unexpected event"),
2304                 }
2305                 check_added_monitors!(nodes[3], 1);
2306
2307                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2308                 {
2309                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2310                         node_txn.retain(|tx| {
2311                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2312                                         false
2313                                 } else { true }
2314                         });
2315                 }
2316
2317                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2318
2319                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2320                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, payment_hash_2);
2321
2322                 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2323                 let events = nodes[4].node.get_and_clear_pending_msg_events();
2324                 assert_eq!(events.len(), 2);
2325                 let close_chan_update_2 = match events[0] {
2326                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2327                                 msg.clone()
2328                         },
2329                         _ => panic!("Unexpected event"),
2330                 };
2331                 match events[1] {
2332                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2333                                 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2334                         },
2335                         _ => panic!("Unexpected event"),
2336                 }
2337                 check_added_monitors!(nodes[4], 1);
2338                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2339
2340                 mine_transaction(&nodes[4], &node_txn[0]);
2341                 check_preimage_claim(&nodes[4], &node_txn);
2342                 (close_chan_update_1, close_chan_update_2)
2343         };
2344         nodes[3].gossip_sync.handle_channel_update(&close_chan_update_2).unwrap();
2345         nodes[4].gossip_sync.handle_channel_update(&close_chan_update_1).unwrap();
2346         assert_eq!(nodes[3].node.list_channels().len(), 0);
2347         assert_eq!(nodes[4].node.list_channels().len(), 0);
2348
2349         assert_eq!(nodes[3].chain_monitor.chain_monitor.watch_channel(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon),
2350                 ChannelMonitorUpdateStatus::Completed);
2351         check_closed_event!(nodes[3], 1, ClosureReason::CommitmentTxConfirmed);
2352         check_closed_event!(nodes[4], 1, ClosureReason::CommitmentTxConfirmed);
2353 }
2354
2355 #[test]
2356 fn test_justice_tx() {
2357         // Test justice txn built on revoked HTLC-Success tx, against both sides
2358         let mut alice_config = UserConfig::default();
2359         alice_config.channel_handshake_config.announced_channel = true;
2360         alice_config.channel_handshake_limits.force_announced_channel_preference = false;
2361         alice_config.channel_handshake_config.our_to_self_delay = 6 * 24 * 5;
2362         let mut bob_config = UserConfig::default();
2363         bob_config.channel_handshake_config.announced_channel = true;
2364         bob_config.channel_handshake_limits.force_announced_channel_preference = false;
2365         bob_config.channel_handshake_config.our_to_self_delay = 6 * 24 * 3;
2366         let user_cfgs = [Some(alice_config), Some(bob_config)];
2367         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2368         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2369         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2370         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2371         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2372         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2373         *nodes[0].connect_style.borrow_mut() = ConnectStyle::FullBlockViaListen;
2374         // Create some new channels:
2375         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1);
2376
2377         // A pending HTLC which will be revoked:
2378         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2379         // Get the will-be-revoked local txn from nodes[0]
2380         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2381         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2382         assert_eq!(revoked_local_txn[0].input.len(), 1);
2383         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2384         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2385         assert_eq!(revoked_local_txn[1].input.len(), 1);
2386         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2387         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2388         // Revoke the old state
2389         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2390
2391         {
2392                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2393                 {
2394                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2395                         assert_eq!(node_txn.len(), 1); // ChannelMonitor: penalty tx
2396                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2397
2398                         check_spends!(node_txn[0], revoked_local_txn[0]);
2399                         node_txn.swap_remove(0);
2400                 }
2401                 check_added_monitors!(nodes[1], 1);
2402                 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2403                 test_txn_broadcast(&nodes[1], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::NONE);
2404
2405                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2406                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2407                 // Verify broadcast of revoked HTLC-timeout
2408                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2409                 check_added_monitors!(nodes[0], 1);
2410                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2411                 // Broadcast revoked HTLC-timeout on node 1
2412                 mine_transaction(&nodes[1], &node_txn[1]);
2413                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2414         }
2415         get_announce_close_broadcast_events(&nodes, 0, 1);
2416
2417         assert_eq!(nodes[0].node.list_channels().len(), 0);
2418         assert_eq!(nodes[1].node.list_channels().len(), 0);
2419
2420         // We test justice_tx build by A on B's revoked HTLC-Success tx
2421         // Create some new channels:
2422         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1);
2423         {
2424                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2425                 node_txn.clear();
2426         }
2427
2428         // A pending HTLC which will be revoked:
2429         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2430         // Get the will-be-revoked local txn from B
2431         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2432         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2433         assert_eq!(revoked_local_txn[0].input.len(), 1);
2434         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2435         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2436         // Revoke the old state
2437         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2438         {
2439                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2440                 {
2441                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2442                         assert_eq!(node_txn.len(), 1); // ChannelMonitor: penalty tx
2443                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2444
2445                         check_spends!(node_txn[0], revoked_local_txn[0]);
2446                         node_txn.swap_remove(0);
2447                 }
2448                 check_added_monitors!(nodes[0], 1);
2449                 test_txn_broadcast(&nodes[0], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::NONE);
2450
2451                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2452                 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2453                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2454                 check_added_monitors!(nodes[1], 1);
2455                 mine_transaction(&nodes[0], &node_txn[1]);
2456                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2457                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2458         }
2459         get_announce_close_broadcast_events(&nodes, 0, 1);
2460         assert_eq!(nodes[0].node.list_channels().len(), 0);
2461         assert_eq!(nodes[1].node.list_channels().len(), 0);
2462 }
2463
2464 #[test]
2465 fn revoked_output_claim() {
2466         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2467         // transaction is broadcast by its counterparty
2468         let chanmon_cfgs = create_chanmon_cfgs(2);
2469         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2470         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2471         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2472         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2473         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2474         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2475         assert_eq!(revoked_local_txn.len(), 1);
2476         // Only output is the full channel value back to nodes[0]:
2477         assert_eq!(revoked_local_txn[0].output.len(), 1);
2478         // Send a payment through, updating everyone's latest commitment txn
2479         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2480
2481         // Inform nodes[1] that nodes[0] broadcast a stale tx
2482         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2483         check_added_monitors!(nodes[1], 1);
2484         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2485         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2486         assert_eq!(node_txn.len(), 1); // ChannelMonitor: justice tx against revoked to_local output
2487
2488         check_spends!(node_txn[0], revoked_local_txn[0]);
2489
2490         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2491         mine_transaction(&nodes[0], &revoked_local_txn[0]);
2492         get_announce_close_broadcast_events(&nodes, 0, 1);
2493         check_added_monitors!(nodes[0], 1);
2494         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2495 }
2496
2497 #[test]
2498 fn claim_htlc_outputs_shared_tx() {
2499         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2500         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2501         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2502         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2503         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2504         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2505
2506         // Create some new channel:
2507         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2508
2509         // Rebalance the network to generate htlc in the two directions
2510         send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
2511         // 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
2512         let payment_preimage_1 = route_payment(&nodes[0], &[&nodes[1]], 3_000_000).0;
2513         let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
2514
2515         // Get the will-be-revoked local txn from node[0]
2516         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2517         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2518         assert_eq!(revoked_local_txn[0].input.len(), 1);
2519         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2520         assert_eq!(revoked_local_txn[1].input.len(), 1);
2521         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2522         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2523         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2524
2525         //Revoke the old state
2526         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2527
2528         {
2529                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2530                 check_added_monitors!(nodes[0], 1);
2531                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2532                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2533                 check_added_monitors!(nodes[1], 1);
2534                 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2535                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2536                 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2537
2538                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2539                 assert_eq!(node_txn.len(), 1); // ChannelMonitor: penalty tx
2540
2541                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2542                 check_spends!(node_txn[0], revoked_local_txn[0]);
2543
2544                 let mut witness_lens = BTreeSet::new();
2545                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2546                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2547                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2548                 assert_eq!(witness_lens.len(), 3);
2549                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2550                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2551                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2552
2553                 // Finally, mine the penalty transaction and check that we get an HTLC failure after
2554                 // ANTI_REORG_DELAY confirmations.
2555                 mine_transaction(&nodes[1], &node_txn[0]);
2556                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2557                 expect_payment_failed!(nodes[1], payment_hash_2, false);
2558         }
2559         get_announce_close_broadcast_events(&nodes, 0, 1);
2560         assert_eq!(nodes[0].node.list_channels().len(), 0);
2561         assert_eq!(nodes[1].node.list_channels().len(), 0);
2562 }
2563
2564 #[test]
2565 fn claim_htlc_outputs_single_tx() {
2566         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2567         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2568         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2569         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2570         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2571         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2572
2573         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2574
2575         // Rebalance the network to generate htlc in the two directions
2576         send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
2577         // 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
2578         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2579         let payment_preimage_1 = route_payment(&nodes[0], &[&nodes[1]], 3_000_000).0;
2580         let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
2581
2582         // Get the will-be-revoked local txn from node[0]
2583         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2584
2585         //Revoke the old state
2586         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2587
2588         {
2589                 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2590                 check_added_monitors!(nodes[0], 1);
2591                 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2592                 check_added_monitors!(nodes[1], 1);
2593                 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2594                 let mut events = nodes[0].node.get_and_clear_pending_events();
2595                 expect_pending_htlcs_forwardable_from_events!(nodes[0], events[0..1], true);
2596                 match events.last().unwrap() {
2597                         Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
2598                         _ => panic!("Unexpected event"),
2599                 }
2600
2601                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2602                 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2603
2604                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2605                 assert_eq!(node_txn.len(), 7);
2606
2607                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2608                 assert_eq!(node_txn[0].input.len(), 1);
2609                 check_spends!(node_txn[0], chan_1.3);
2610                 assert_eq!(node_txn[1].input.len(), 1);
2611                 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2612                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2613                 check_spends!(node_txn[1], node_txn[0]);
2614
2615                 // Justice transactions are indices 2-3-4
2616                 assert_eq!(node_txn[2].input.len(), 1);
2617                 assert_eq!(node_txn[3].input.len(), 1);
2618                 assert_eq!(node_txn[4].input.len(), 1);
2619
2620                 check_spends!(node_txn[2], revoked_local_txn[0]);
2621                 check_spends!(node_txn[3], revoked_local_txn[0]);
2622                 check_spends!(node_txn[4], revoked_local_txn[0]);
2623
2624                 let mut witness_lens = BTreeSet::new();
2625                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2626                 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2627                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2628                 assert_eq!(witness_lens.len(), 3);
2629                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2630                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2631                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2632
2633                 // Finally, mine the penalty transactions and check that we get an HTLC failure after
2634                 // ANTI_REORG_DELAY confirmations.
2635                 mine_transaction(&nodes[1], &node_txn[2]);
2636                 mine_transaction(&nodes[1], &node_txn[3]);
2637                 mine_transaction(&nodes[1], &node_txn[4]);
2638                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2639                 expect_payment_failed!(nodes[1], payment_hash_2, false);
2640         }
2641         get_announce_close_broadcast_events(&nodes, 0, 1);
2642         assert_eq!(nodes[0].node.list_channels().len(), 0);
2643         assert_eq!(nodes[1].node.list_channels().len(), 0);
2644 }
2645
2646 #[test]
2647 fn test_htlc_on_chain_success() {
2648         // Test that in case of a unilateral close onchain, we detect the state of output and pass
2649         // the preimage backward accordingly. So here we test that ChannelManager is
2650         // broadcasting the right event to other nodes in payment path.
2651         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2652         // A --------------------> B ----------------------> C (preimage)
2653         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2654         // commitment transaction was broadcast.
2655         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2656         // towards B.
2657         // B should be able to claim via preimage if A then broadcasts its local tx.
2658         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2659         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2660         // PaymentSent event).
2661
2662         let chanmon_cfgs = create_chanmon_cfgs(3);
2663         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2664         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2665         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2666
2667         // Create some initial channels
2668         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2669         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2670
2671         // Ensure all nodes are at the same height
2672         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2673         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2674         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2675         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2676
2677         // Rebalance the network a bit by relaying one payment through all the channels...
2678         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2679         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2680
2681         let (our_payment_preimage, payment_hash_1, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3_000_000);
2682         let (our_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3_000_000);
2683
2684         // Broadcast legit commitment tx from C on B's chain
2685         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2686         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2687         assert_eq!(commitment_tx.len(), 1);
2688         check_spends!(commitment_tx[0], chan_2.3);
2689         nodes[2].node.claim_funds(our_payment_preimage);
2690         expect_payment_claimed!(nodes[2], payment_hash_1, 3_000_000);
2691         nodes[2].node.claim_funds(our_payment_preimage_2);
2692         expect_payment_claimed!(nodes[2], payment_hash_2, 3_000_000);
2693         check_added_monitors!(nodes[2], 2);
2694         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2695         assert!(updates.update_add_htlcs.is_empty());
2696         assert!(updates.update_fail_htlcs.is_empty());
2697         assert!(updates.update_fail_malformed_htlcs.is_empty());
2698         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2699
2700         mine_transaction(&nodes[2], &commitment_tx[0]);
2701         check_closed_broadcast!(nodes[2], true);
2702         check_added_monitors!(nodes[2], 1);
2703         check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
2704         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelMonitor: 2 (2 * HTLC-Success tx)
2705         assert_eq!(node_txn.len(), 2);
2706         check_spends!(node_txn[0], commitment_tx[0]);
2707         check_spends!(node_txn[1], commitment_tx[0]);
2708         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2709         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2710         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2711         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2712         assert_eq!(node_txn[0].lock_time.0, 0);
2713         assert_eq!(node_txn[1].lock_time.0, 0);
2714
2715         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2716         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42};
2717         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone(), node_txn[1].clone()]});
2718         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2719         {
2720                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2721                 assert_eq!(added_monitors.len(), 1);
2722                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2723                 added_monitors.clear();
2724         }
2725         let forwarded_events = nodes[1].node.get_and_clear_pending_events();
2726         assert_eq!(forwarded_events.len(), 3);
2727         match forwarded_events[0] {
2728                 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
2729                 _ => panic!("Unexpected event"),
2730         }
2731         let chan_id = Some(chan_1.2);
2732         match forwarded_events[1] {
2733                 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
2734                         assert_eq!(fee_earned_msat, Some(1000));
2735                         assert_eq!(prev_channel_id, chan_id);
2736                         assert_eq!(claim_from_onchain_tx, true);
2737                         assert_eq!(next_channel_id, Some(chan_2.2));
2738                 },
2739                 _ => panic!()
2740         }
2741         match forwarded_events[2] {
2742                 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
2743                         assert_eq!(fee_earned_msat, Some(1000));
2744                         assert_eq!(prev_channel_id, chan_id);
2745                         assert_eq!(claim_from_onchain_tx, true);
2746                         assert_eq!(next_channel_id, Some(chan_2.2));
2747                 },
2748                 _ => panic!()
2749         }
2750         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2751         {
2752                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2753                 assert_eq!(added_monitors.len(), 2);
2754                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2755                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2756                 added_monitors.clear();
2757         }
2758         assert_eq!(events.len(), 3);
2759
2760         let nodes_2_event = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
2761         let nodes_0_event = remove_first_msg_event_to_node(&nodes[0].node.get_our_node_id(), &mut events);
2762
2763         match nodes_2_event {
2764                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2765                 _ => panic!("Unexpected event"),
2766         }
2767
2768         match nodes_0_event {
2769                 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, .. } } => {
2770                         assert!(update_add_htlcs.is_empty());
2771                         assert!(update_fail_htlcs.is_empty());
2772                         assert_eq!(update_fulfill_htlcs.len(), 1);
2773                         assert!(update_fail_malformed_htlcs.is_empty());
2774                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2775                 },
2776                 _ => panic!("Unexpected event"),
2777         };
2778
2779         // Ensure that the last remaining message event is the BroadcastChannelUpdate msg for chan_2
2780         match events[0] {
2781                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2782                 _ => panic!("Unexpected event"),
2783         }
2784
2785         macro_rules! check_tx_local_broadcast {
2786                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr) => { {
2787                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2788                         assert_eq!(node_txn.len(), 2);
2789                         // Node[1]: 2 * HTLC-timeout tx
2790                         // Node[0]: 2 * HTLC-timeout tx
2791                         check_spends!(node_txn[0], $commitment_tx);
2792                         check_spends!(node_txn[1], $commitment_tx);
2793                         assert_ne!(node_txn[0].lock_time.0, 0);
2794                         assert_ne!(node_txn[1].lock_time.0, 0);
2795                         if $htlc_offered {
2796                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2797                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2798                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2799                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2800                         } else {
2801                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2802                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2803                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2804                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2805                         }
2806                         node_txn.clear();
2807                 } }
2808         }
2809         // nodes[1] now broadcasts its own timeout-claim of the output that nodes[2] just claimed via success.
2810         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0]);
2811
2812         // Broadcast legit commitment tx from A on B's chain
2813         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2814         let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2815         check_spends!(node_a_commitment_tx[0], chan_1.3);
2816         mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2817         check_closed_broadcast!(nodes[1], true);
2818         check_added_monitors!(nodes[1], 1);
2819         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2820         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2821         assert!(node_txn.len() == 1 || node_txn.len() == 3); // HTLC-Success, 2* RBF bumps of above HTLC txn
2822         let commitment_spend =
2823                 if node_txn.len() == 1 {
2824                         &node_txn[0]
2825                 } else {
2826                         // Certain `ConnectStyle`s will cause RBF bumps of the previous HTLC transaction to be broadcast.
2827                         // FullBlockViaListen
2828                         if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2829                                 check_spends!(node_txn[1], commitment_tx[0]);
2830                                 check_spends!(node_txn[2], commitment_tx[0]);
2831                                 assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2832                                 &node_txn[0]
2833                         } else {
2834                                 check_spends!(node_txn[0], commitment_tx[0]);
2835                                 check_spends!(node_txn[1], commitment_tx[0]);
2836                                 assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2837                                 &node_txn[2]
2838                         }
2839                 };
2840
2841         check_spends!(commitment_spend, node_a_commitment_tx[0]);
2842         assert_eq!(commitment_spend.input.len(), 2);
2843         assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2844         assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2845         assert_eq!(commitment_spend.lock_time.0, 0);
2846         assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2847         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2848         // we already checked the same situation with A.
2849
2850         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2851         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42};
2852         connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
2853         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2854         check_closed_broadcast!(nodes[0], true);
2855         check_added_monitors!(nodes[0], 1);
2856         let events = nodes[0].node.get_and_clear_pending_events();
2857         assert_eq!(events.len(), 5);
2858         let mut first_claimed = false;
2859         for event in events {
2860                 match event {
2861                         Event::PaymentSent { payment_preimage, payment_hash, .. } => {
2862                                 if payment_preimage == our_payment_preimage && payment_hash == payment_hash_1 {
2863                                         assert!(!first_claimed);
2864                                         first_claimed = true;
2865                                 } else {
2866                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2867                                         assert_eq!(payment_hash, payment_hash_2);
2868                                 }
2869                         },
2870                         Event::PaymentPathSuccessful { .. } => {},
2871                         Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {},
2872                         _ => panic!("Unexpected event"),
2873                 }
2874         }
2875         check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0]);
2876 }
2877
2878 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2879         // Test that in case of a unilateral close onchain, we detect the state of output and
2880         // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2881         // broadcasting the right event to other nodes in payment path.
2882         // A ------------------> B ----------------------> C (timeout)
2883         //    B's commitment tx                 C's commitment tx
2884         //            \                                  \
2885         //         B's HTLC timeout tx               B's timeout tx
2886
2887         let chanmon_cfgs = create_chanmon_cfgs(3);
2888         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2889         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2890         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2891         *nodes[0].connect_style.borrow_mut() = connect_style;
2892         *nodes[1].connect_style.borrow_mut() = connect_style;
2893         *nodes[2].connect_style.borrow_mut() = connect_style;
2894
2895         // Create some intial channels
2896         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2897         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2898
2899         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2900         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2901         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2902
2903         let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2904
2905         // Broadcast legit commitment tx from C on B's chain
2906         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2907         check_spends!(commitment_tx[0], chan_2.3);
2908         nodes[2].node.fail_htlc_backwards(&payment_hash);
2909         check_added_monitors!(nodes[2], 0);
2910         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }]);
2911         check_added_monitors!(nodes[2], 1);
2912
2913         let events = nodes[2].node.get_and_clear_pending_msg_events();
2914         assert_eq!(events.len(), 1);
2915         match events[0] {
2916                 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, .. } } => {
2917                         assert!(update_add_htlcs.is_empty());
2918                         assert!(!update_fail_htlcs.is_empty());
2919                         assert!(update_fulfill_htlcs.is_empty());
2920                         assert!(update_fail_malformed_htlcs.is_empty());
2921                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2922                 },
2923                 _ => panic!("Unexpected event"),
2924         };
2925         mine_transaction(&nodes[2], &commitment_tx[0]);
2926         check_closed_broadcast!(nodes[2], true);
2927         check_added_monitors!(nodes[2], 1);
2928         check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
2929         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2930         assert_eq!(node_txn.len(), 0);
2931
2932         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2933         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2934         connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2935         mine_transaction(&nodes[1], &commitment_tx[0]);
2936         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2937         let timeout_tx;
2938         {
2939                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2940                 assert_eq!(node_txn.len(), 3); // 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2941
2942                 check_spends!(node_txn[2], commitment_tx[0]);
2943                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2944
2945                 check_spends!(node_txn[0], chan_2.3);
2946                 check_spends!(node_txn[1], node_txn[0]);
2947                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2948                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2949
2950                 timeout_tx = node_txn[2].clone();
2951                 node_txn.clear();
2952         }
2953
2954         mine_transaction(&nodes[1], &timeout_tx);
2955         check_added_monitors!(nodes[1], 1);
2956         check_closed_broadcast!(nodes[1], true);
2957
2958         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2959
2960         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
2961         check_added_monitors!(nodes[1], 1);
2962         let events = nodes[1].node.get_and_clear_pending_msg_events();
2963         assert_eq!(events.len(), 1);
2964         match events[0] {
2965                 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, .. } } => {
2966                         assert!(update_add_htlcs.is_empty());
2967                         assert!(!update_fail_htlcs.is_empty());
2968                         assert!(update_fulfill_htlcs.is_empty());
2969                         assert!(update_fail_malformed_htlcs.is_empty());
2970                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2971                 },
2972                 _ => panic!("Unexpected event"),
2973         };
2974
2975         // Broadcast legit commitment tx from B on A's chain
2976         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
2977         check_spends!(commitment_tx[0], chan_1.3);
2978
2979         mine_transaction(&nodes[0], &commitment_tx[0]);
2980         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2981
2982         check_closed_broadcast!(nodes[0], true);
2983         check_added_monitors!(nodes[0], 1);
2984         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2985         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // 1 timeout tx
2986         assert_eq!(node_txn.len(), 1);
2987         check_spends!(node_txn[0], commitment_tx[0]);
2988         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2989 }
2990
2991 #[test]
2992 fn test_htlc_on_chain_timeout() {
2993         do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
2994         do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
2995         do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
2996 }
2997
2998 #[test]
2999 fn test_simple_commitment_revoked_fail_backward() {
3000         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3001         // and fail backward accordingly.
3002
3003         let chanmon_cfgs = create_chanmon_cfgs(3);
3004         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3005         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3006         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3007
3008         // Create some initial channels
3009         create_announced_chan_between_nodes(&nodes, 0, 1);
3010         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
3011
3012         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3013         // Get the will-be-revoked local txn from nodes[2]
3014         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3015         // Revoke the old state
3016         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3017
3018         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3019
3020         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3021         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
3022         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3023         check_added_monitors!(nodes[1], 1);
3024         check_closed_broadcast!(nodes[1], true);
3025
3026         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
3027         check_added_monitors!(nodes[1], 1);
3028         let events = nodes[1].node.get_and_clear_pending_msg_events();
3029         assert_eq!(events.len(), 1);
3030         match events[0] {
3031                 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, .. } } => {
3032                         assert!(update_add_htlcs.is_empty());
3033                         assert_eq!(update_fail_htlcs.len(), 1);
3034                         assert!(update_fulfill_htlcs.is_empty());
3035                         assert!(update_fail_malformed_htlcs.is_empty());
3036                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3037
3038                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3039                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3040                         expect_payment_failed_with_update!(nodes[0], payment_hash, false, chan_2.0.contents.short_channel_id, true);
3041                 },
3042                 _ => panic!("Unexpected event"),
3043         }
3044 }
3045
3046 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3047         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3048         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3049         // commitment transaction anymore.
3050         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3051         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3052         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3053         // technically disallowed and we should probably handle it reasonably.
3054         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3055         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3056         // transactions:
3057         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3058         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3059         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3060         //   and once they revoke the previous commitment transaction (allowing us to send a new
3061         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3062         let chanmon_cfgs = create_chanmon_cfgs(3);
3063         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3064         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3065         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3066
3067         // Create some initial channels
3068         create_announced_chan_between_nodes(&nodes, 0, 1);
3069         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
3070
3071         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 });
3072         // Get the will-be-revoked local txn from nodes[2]
3073         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3074         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3075         // Revoke the old state
3076         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3077
3078         let value = if use_dust {
3079                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3080                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3081                 nodes[2].node.per_peer_state.read().unwrap().get(&nodes[1].node.get_our_node_id())
3082                         .unwrap().lock().unwrap().channel_by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3083         } else { 3000000 };
3084
3085         let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3086         let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3087         let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3088
3089         nodes[2].node.fail_htlc_backwards(&first_payment_hash);
3090         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: first_payment_hash }]);
3091         check_added_monitors!(nodes[2], 1);
3092         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3093         assert!(updates.update_add_htlcs.is_empty());
3094         assert!(updates.update_fulfill_htlcs.is_empty());
3095         assert!(updates.update_fail_malformed_htlcs.is_empty());
3096         assert_eq!(updates.update_fail_htlcs.len(), 1);
3097         assert!(updates.update_fee.is_none());
3098         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3099         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3100         // Drop the last RAA from 3 -> 2
3101
3102         nodes[2].node.fail_htlc_backwards(&second_payment_hash);
3103         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: second_payment_hash }]);
3104         check_added_monitors!(nodes[2], 1);
3105         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3106         assert!(updates.update_add_htlcs.is_empty());
3107         assert!(updates.update_fulfill_htlcs.is_empty());
3108         assert!(updates.update_fail_malformed_htlcs.is_empty());
3109         assert_eq!(updates.update_fail_htlcs.len(), 1);
3110         assert!(updates.update_fee.is_none());
3111         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3112         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3113         check_added_monitors!(nodes[1], 1);
3114         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3115         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3116         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3117         check_added_monitors!(nodes[2], 1);
3118
3119         nodes[2].node.fail_htlc_backwards(&third_payment_hash);
3120         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: third_payment_hash }]);
3121         check_added_monitors!(nodes[2], 1);
3122         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3123         assert!(updates.update_add_htlcs.is_empty());
3124         assert!(updates.update_fulfill_htlcs.is_empty());
3125         assert!(updates.update_fail_malformed_htlcs.is_empty());
3126         assert_eq!(updates.update_fail_htlcs.len(), 1);
3127         assert!(updates.update_fee.is_none());
3128         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3129         // At this point first_payment_hash has dropped out of the latest two commitment
3130         // transactions that nodes[1] is tracking...
3131         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3132         check_added_monitors!(nodes[1], 1);
3133         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3134         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3135         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3136         check_added_monitors!(nodes[2], 1);
3137
3138         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3139         // on nodes[2]'s RAA.
3140         let (route, fourth_payment_hash, _, fourth_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[2], 1000000);
3141         nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret), PaymentId(fourth_payment_hash.0)).unwrap();
3142         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3143         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3144         check_added_monitors!(nodes[1], 0);
3145
3146         if deliver_bs_raa {
3147                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3148                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3149                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3150                 check_added_monitors!(nodes[1], 1);
3151                 let events = nodes[1].node.get_and_clear_pending_events();
3152                 assert_eq!(events.len(), 2);
3153                 match events[0] {
3154                         Event::PendingHTLCsForwardable { .. } => { },
3155                         _ => panic!("Unexpected event"),
3156                 };
3157                 match events[1] {
3158                         Event::HTLCHandlingFailed { .. } => { },
3159                         _ => panic!("Unexpected event"),
3160                 }
3161                 // Deliberately don't process the pending fail-back so they all fail back at once after
3162                 // block connection just like the !deliver_bs_raa case
3163         }
3164
3165         let mut failed_htlcs = HashSet::new();
3166         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3167
3168         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3169         check_added_monitors!(nodes[1], 1);
3170         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3171
3172         let events = nodes[1].node.get_and_clear_pending_events();
3173         assert_eq!(events.len(), if deliver_bs_raa { 3 + nodes.len() - 1 } else { 4 + nodes.len() });
3174         match events[0] {
3175                 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => { },
3176                 _ => panic!("Unexepected event"),
3177         }
3178         match events[1] {
3179                 Event::PaymentPathFailed { ref payment_hash, .. } => {
3180                         assert_eq!(*payment_hash, fourth_payment_hash);
3181                 },
3182                 _ => panic!("Unexpected event"),
3183         }
3184         match events[2] {
3185                 Event::PaymentFailed { ref payment_hash, .. } => {
3186                         assert_eq!(*payment_hash, fourth_payment_hash);
3187                 },
3188                 _ => panic!("Unexpected event"),
3189         }
3190
3191         nodes[1].node.process_pending_htlc_forwards();
3192         check_added_monitors!(nodes[1], 1);
3193
3194         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
3195         assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3196
3197         if deliver_bs_raa {
3198                 let nodes_2_event = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
3199                 match nodes_2_event {
3200                         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, .. } } => {
3201                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3202                                 assert_eq!(update_add_htlcs.len(), 1);
3203                                 assert!(update_fulfill_htlcs.is_empty());
3204                                 assert!(update_fail_htlcs.is_empty());
3205                                 assert!(update_fail_malformed_htlcs.is_empty());
3206                         },
3207                         _ => panic!("Unexpected event"),
3208                 }
3209         }
3210
3211         let nodes_2_event = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
3212         match nodes_2_event {
3213                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3214                         assert_eq!(channel_id, chan_2.2);
3215                         assert_eq!(data.as_str(), "Channel closed because commitment or closing transaction was confirmed on chain.");
3216                 },
3217                 _ => panic!("Unexpected event"),
3218         }
3219
3220         let nodes_0_event = remove_first_msg_event_to_node(&nodes[0].node.get_our_node_id(), &mut events);
3221         match nodes_0_event {
3222                 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, .. } } => {
3223                         assert!(update_add_htlcs.is_empty());
3224                         assert_eq!(update_fail_htlcs.len(), 3);
3225                         assert!(update_fulfill_htlcs.is_empty());
3226                         assert!(update_fail_malformed_htlcs.is_empty());
3227                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3228
3229                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3230                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3231                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3232
3233                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3234
3235                         let events = nodes[0].node.get_and_clear_pending_events();
3236                         assert_eq!(events.len(), 6);
3237                         match events[0] {
3238                                 Event::PaymentPathFailed { ref payment_hash, ref network_update, .. } => {
3239                                         assert!(failed_htlcs.insert(payment_hash.0));
3240                                         // If we delivered B's RAA we got an unknown preimage error, not something
3241                                         // that we should update our routing table for.
3242                                         if !deliver_bs_raa {
3243                                                 assert!(network_update.is_some());
3244                                         }
3245                                 },
3246                                 _ => panic!("Unexpected event"),
3247                         }
3248                         match events[1] {
3249                                 Event::PaymentFailed { ref payment_hash, .. } => {
3250                                         assert_eq!(*payment_hash, first_payment_hash);
3251                                 },
3252                                 _ => panic!("Unexpected event"),
3253                         }
3254                         match events[2] {
3255                                 Event::PaymentPathFailed { ref payment_hash, ref network_update, .. } => {
3256                                         assert!(failed_htlcs.insert(payment_hash.0));
3257                                         assert!(network_update.is_some());
3258                                 },
3259                                 _ => panic!("Unexpected event"),
3260                         }
3261                         match events[3] {
3262                                 Event::PaymentFailed { ref payment_hash, .. } => {
3263                                         assert_eq!(*payment_hash, second_payment_hash);
3264                                 },
3265                                 _ => panic!("Unexpected event"),
3266                         }
3267                         match events[4] {
3268                                 Event::PaymentPathFailed { ref payment_hash, ref network_update, .. } => {
3269                                         assert!(failed_htlcs.insert(payment_hash.0));
3270                                         assert!(network_update.is_some());
3271                                 },
3272                                 _ => panic!("Unexpected event"),
3273                         }
3274                         match events[5] {
3275                                 Event::PaymentFailed { ref payment_hash, .. } => {
3276                                         assert_eq!(*payment_hash, third_payment_hash);
3277                                 },
3278                                 _ => panic!("Unexpected event"),
3279                         }
3280                 },
3281                 _ => panic!("Unexpected event"),
3282         }
3283
3284         // Ensure that the last remaining message event is the BroadcastChannelUpdate msg for chan_2
3285         match events[0] {
3286                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3287                 _ => panic!("Unexpected event"),
3288         }
3289
3290         assert!(failed_htlcs.contains(&first_payment_hash.0));
3291         assert!(failed_htlcs.contains(&second_payment_hash.0));
3292         assert!(failed_htlcs.contains(&third_payment_hash.0));
3293 }
3294
3295 #[test]
3296 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3297         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3298         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3299         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3300         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3301 }
3302
3303 #[test]
3304 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3305         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3306         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3307         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3308         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3309 }
3310
3311 #[test]
3312 fn fail_backward_pending_htlc_upon_channel_failure() {
3313         let chanmon_cfgs = create_chanmon_cfgs(2);
3314         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3315         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3316         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3317         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000);
3318
3319         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3320         {
3321                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 50_000);
3322                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
3323                 check_added_monitors!(nodes[0], 1);
3324
3325                 let payment_event = {
3326                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3327                         assert_eq!(events.len(), 1);
3328                         SendEvent::from_event(events.remove(0))
3329                 };
3330                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3331                 assert_eq!(payment_event.msgs.len(), 1);
3332         }
3333
3334         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3335         let (route, failed_payment_hash, _, failed_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 50_000);
3336         {
3337                 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret), PaymentId(failed_payment_hash.0)).unwrap();
3338                 check_added_monitors!(nodes[0], 0);
3339
3340                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3341         }
3342
3343         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3344         {
3345                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 50_000);
3346
3347                 let secp_ctx = Secp256k1::new();
3348                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3349                 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3350                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height, &None).unwrap();
3351                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3352                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3353
3354                 // Send a 0-msat update_add_htlc to fail the channel.
3355                 let update_add_htlc = msgs::UpdateAddHTLC {
3356                         channel_id: chan.2,
3357                         htlc_id: 0,
3358                         amount_msat: 0,
3359                         payment_hash,
3360                         cltv_expiry,
3361                         onion_routing_packet,
3362                 };
3363                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3364         }
3365         let events = nodes[0].node.get_and_clear_pending_events();
3366         assert_eq!(events.len(), 3);
3367         // Check that Alice fails backward the pending HTLC from the second payment.
3368         match events[0] {
3369                 Event::PaymentPathFailed { payment_hash, .. } => {
3370                         assert_eq!(payment_hash, failed_payment_hash);
3371                 },
3372                 _ => panic!("Unexpected event"),
3373         }
3374         match events[1] {
3375                 Event::PaymentFailed { payment_hash, .. } => {
3376                         assert_eq!(payment_hash, failed_payment_hash);
3377                 },
3378                 _ => panic!("Unexpected event"),
3379         }
3380         match events[2] {
3381                 Event::ChannelClosed { reason: ClosureReason::ProcessingError { ref err }, .. } => {
3382                         assert_eq!(err, "Remote side tried to send a 0-msat HTLC");
3383                 },
3384                 _ => panic!("Unexpected event {:?}", events[1]),
3385         }
3386         check_closed_broadcast!(nodes[0], true);
3387         check_added_monitors!(nodes[0], 1);
3388 }
3389
3390 #[test]
3391 fn test_htlc_ignore_latest_remote_commitment() {
3392         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3393         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3394         let chanmon_cfgs = create_chanmon_cfgs(2);
3395         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3396         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3397         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3398         if *nodes[1].connect_style.borrow() == ConnectStyle::FullBlockViaListen {
3399                 // We rely on the ability to connect a block redundantly, which isn't allowed via
3400                 // `chain::Listen`, so we never run the test if we randomly get assigned that
3401                 // connect_style.
3402                 return;
3403         }
3404         create_announced_chan_between_nodes(&nodes, 0, 1);
3405
3406         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3407         nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
3408         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3409         check_closed_broadcast!(nodes[0], true);
3410         check_added_monitors!(nodes[0], 1);
3411         check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
3412
3413         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3414         assert_eq!(node_txn.len(), 3);
3415         assert_eq!(node_txn[0], node_txn[1]);
3416
3417         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
3418         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3419         check_closed_broadcast!(nodes[1], true);
3420         check_added_monitors!(nodes[1], 1);
3421         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
3422
3423         // Duplicate the connect_block call since this may happen due to other listeners
3424         // registering new transactions
3425         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3426 }
3427
3428 #[test]
3429 fn test_force_close_fail_back() {
3430         // Check which HTLCs are failed-backwards on channel force-closure
3431         let chanmon_cfgs = create_chanmon_cfgs(3);
3432         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3433         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3434         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3435         create_announced_chan_between_nodes(&nodes, 0, 1);
3436         create_announced_chan_between_nodes(&nodes, 1, 2);
3437
3438         let (route, our_payment_hash, our_payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
3439
3440         let mut payment_event = {
3441                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
3442                 check_added_monitors!(nodes[0], 1);
3443
3444                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3445                 assert_eq!(events.len(), 1);
3446                 SendEvent::from_event(events.remove(0))
3447         };
3448
3449         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3450         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3451
3452         expect_pending_htlcs_forwardable!(nodes[1]);
3453
3454         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3455         assert_eq!(events_2.len(), 1);
3456         payment_event = SendEvent::from_event(events_2.remove(0));
3457         assert_eq!(payment_event.msgs.len(), 1);
3458
3459         check_added_monitors!(nodes[1], 1);
3460         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3461         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3462         check_added_monitors!(nodes[2], 1);
3463         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3464
3465         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3466         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3467         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3468
3469         nodes[2].node.force_close_broadcasting_latest_txn(&payment_event.commitment_msg.channel_id, &nodes[1].node.get_our_node_id()).unwrap();
3470         check_closed_broadcast!(nodes[2], true);
3471         check_added_monitors!(nodes[2], 1);
3472         check_closed_event!(nodes[2], 1, ClosureReason::HolderForceClosed);
3473         let tx = {
3474                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3475                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3476                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3477                 // back to nodes[1] upon timeout otherwise.
3478                 assert_eq!(node_txn.len(), 1);
3479                 node_txn.remove(0)
3480         };
3481
3482         mine_transaction(&nodes[1], &tx);
3483
3484         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3485         check_closed_broadcast!(nodes[1], true);
3486         check_added_monitors!(nodes[1], 1);
3487         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
3488
3489         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3490         {
3491                 get_monitor!(nodes[2], payment_event.commitment_msg.channel_id)
3492                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &LowerBoundedFeeEstimator::new(node_cfgs[2].fee_estimator), &node_cfgs[2].logger);
3493         }
3494         mine_transaction(&nodes[2], &tx);
3495         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3496         assert_eq!(node_txn.len(), 1);
3497         assert_eq!(node_txn[0].input.len(), 1);
3498         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3499         assert_eq!(node_txn[0].lock_time.0, 0); // Must be an HTLC-Success
3500         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3501
3502         check_spends!(node_txn[0], tx);
3503 }
3504
3505 #[test]
3506 fn test_dup_events_on_peer_disconnect() {
3507         // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3508         // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3509         // as we used to generate the event immediately upon receipt of the payment preimage in the
3510         // update_fulfill_htlc message.
3511
3512         let chanmon_cfgs = create_chanmon_cfgs(2);
3513         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3514         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3515         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3516         create_announced_chan_between_nodes(&nodes, 0, 1);
3517
3518         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
3519
3520         nodes[1].node.claim_funds(payment_preimage);
3521         expect_payment_claimed!(nodes[1], payment_hash, 1_000_000);
3522         check_added_monitors!(nodes[1], 1);
3523         let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3524         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3525         expect_payment_sent_without_paths!(nodes[0], payment_preimage);
3526
3527         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3528         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
3529
3530         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3531         expect_payment_path_successful!(nodes[0]);
3532 }
3533
3534 #[test]
3535 fn test_peer_disconnected_before_funding_broadcasted() {
3536         // Test that channels are closed with `ClosureReason::DisconnectedPeer` if the peer disconnects
3537         // before the funding transaction has been broadcasted.
3538         let chanmon_cfgs = create_chanmon_cfgs(2);
3539         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3540         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3541         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3542
3543         // Open a channel between `nodes[0]` and `nodes[1]`, for which the funding transaction is never
3544         // broadcasted, even though it's created by `nodes[0]`.
3545         let expected_temporary_channel_id = nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
3546         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
3547         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
3548         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
3549         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
3550
3551         let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
3552         assert_eq!(temporary_channel_id, expected_temporary_channel_id);
3553
3554         assert!(nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).is_ok());
3555
3556         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
3557         assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
3558
3559         // Even though the funding transaction is created by `nodes[0]`, the `FundingCreated` msg is
3560         // never sent to `nodes[1]`, and therefore the tx is never signed by either party nor
3561         // broadcasted.
3562         {
3563                 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
3564         }
3565
3566         // Ensure that the channel is closed with `ClosureReason::DisconnectedPeer` when the peers are
3567         // disconnected before the funding transaction was broadcasted.
3568         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3569         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
3570
3571         check_closed_event!(nodes[0], 1, ClosureReason::DisconnectedPeer);
3572         check_closed_event!(nodes[1], 1, ClosureReason::DisconnectedPeer);
3573 }
3574
3575 #[test]
3576 fn test_simple_peer_disconnect() {
3577         // Test that we can reconnect when there are no lost messages
3578         let chanmon_cfgs = create_chanmon_cfgs(3);
3579         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3580         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3581         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3582         create_announced_chan_between_nodes(&nodes, 0, 1);
3583         create_announced_chan_between_nodes(&nodes, 1, 2);
3584
3585         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3586         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
3587         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3588
3589         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3590         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3591         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3592         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3593
3594         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3595         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
3596         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3597
3598         let (payment_preimage_3, payment_hash_3, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000);
3599         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3600         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3601         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3602
3603         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3604         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
3605
3606         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3607         fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_hash_5);
3608
3609         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3610         {
3611                 let events = nodes[0].node.get_and_clear_pending_events();
3612                 assert_eq!(events.len(), 4);
3613                 match events[0] {
3614                         Event::PaymentSent { payment_preimage, payment_hash, .. } => {
3615                                 assert_eq!(payment_preimage, payment_preimage_3);
3616                                 assert_eq!(payment_hash, payment_hash_3);
3617                         },
3618                         _ => panic!("Unexpected event"),
3619                 }
3620                 match events[1] {
3621                         Event::PaymentPathSuccessful { .. } => {},
3622                         _ => panic!("Unexpected event"),
3623                 }
3624                 match events[2] {
3625                         Event::PaymentPathFailed { payment_hash, payment_failed_permanently, .. } => {
3626                                 assert_eq!(payment_hash, payment_hash_5);
3627                                 assert!(payment_failed_permanently);
3628                         },
3629                         _ => panic!("Unexpected event"),
3630                 }
3631                 match events[3] {
3632                         Event::PaymentFailed { payment_hash, .. } => {
3633                                 assert_eq!(payment_hash, payment_hash_5);
3634                         },
3635                         _ => panic!("Unexpected event"),
3636                 }
3637         }
3638
3639         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3640         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3641 }
3642
3643 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken_lnd: bool) {
3644         // Test that we can reconnect when in-flight HTLC updates get dropped
3645         let chanmon_cfgs = create_chanmon_cfgs(2);
3646         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3647         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3648         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3649
3650         let mut as_channel_ready = None;
3651         let channel_id = if messages_delivered == 0 {
3652                 let (channel_ready, chan_id, _) = create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001);
3653                 as_channel_ready = Some(channel_ready);
3654                 // nodes[1] doesn't receive the channel_ready message (it'll be re-sent on reconnect)
3655                 // Note that we store it so that if we're running with `simulate_broken_lnd` we can deliver
3656                 // it before the channel_reestablish message.
3657                 chan_id
3658         } else {
3659                 create_announced_chan_between_nodes(&nodes, 0, 1).2
3660         };
3661
3662         let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1_000_000);
3663
3664         let payment_event = {
3665                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
3666                 check_added_monitors!(nodes[0], 1);
3667
3668                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3669                 assert_eq!(events.len(), 1);
3670                 SendEvent::from_event(events.remove(0))
3671         };
3672         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3673
3674         if messages_delivered < 2 {
3675                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3676         } else {
3677                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3678                 if messages_delivered >= 3 {
3679                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3680                         check_added_monitors!(nodes[1], 1);
3681                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3682
3683                         if messages_delivered >= 4 {
3684                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3685                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3686                                 check_added_monitors!(nodes[0], 1);
3687
3688                                 if messages_delivered >= 5 {
3689                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3690                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3691                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3692                                         check_added_monitors!(nodes[0], 1);
3693
3694                                         if messages_delivered >= 6 {
3695                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3696                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3697                                                 check_added_monitors!(nodes[1], 1);
3698                                         }
3699                                 }
3700                         }
3701                 }
3702         }
3703
3704         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3705         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
3706         if messages_delivered < 3 {
3707                 if simulate_broken_lnd {
3708                         // lnd has a long-standing bug where they send a channel_ready prior to a
3709                         // channel_reestablish if you reconnect prior to channel_ready time.
3710                         //
3711                         // Here we simulate that behavior, delivering a channel_ready immediately on
3712                         // reconnect. Note that we don't bother skipping the now-duplicate channel_ready sent
3713                         // in `reconnect_nodes` but we currently don't fail based on that.
3714                         //
3715                         // See-also <https://github.com/lightningnetwork/lnd/issues/4006>
3716                         nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &as_channel_ready.as_ref().unwrap().0);
3717                 }
3718                 // Even if the channel_ready messages get exchanged, as long as nothing further was
3719                 // received on either side, both sides will need to resend them.
3720                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3721         } else if messages_delivered == 3 {
3722                 // nodes[0] still wants its RAA + commitment_signed
3723                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3724         } else if messages_delivered == 4 {
3725                 // nodes[0] still wants its commitment_signed
3726                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3727         } else if messages_delivered == 5 {
3728                 // nodes[1] still wants its final RAA
3729                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3730         } else if messages_delivered == 6 {
3731                 // Everything was delivered...
3732                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3733         }
3734
3735         let events_1 = nodes[1].node.get_and_clear_pending_events();
3736         if messages_delivered == 0 {
3737                 assert_eq!(events_1.len(), 2);
3738                 match events_1[0] {
3739                         Event::ChannelReady { .. } => { },
3740                         _ => panic!("Unexpected event"),
3741                 };
3742                 match events_1[1] {
3743                         Event::PendingHTLCsForwardable { .. } => { },
3744                         _ => panic!("Unexpected event"),
3745                 };
3746         } else {
3747                 assert_eq!(events_1.len(), 1);
3748                 match events_1[0] {
3749                         Event::PendingHTLCsForwardable { .. } => { },
3750                         _ => panic!("Unexpected event"),
3751                 };
3752         }
3753
3754         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3755         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
3756         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3757
3758         nodes[1].node.process_pending_htlc_forwards();
3759
3760         let events_2 = nodes[1].node.get_and_clear_pending_events();
3761         assert_eq!(events_2.len(), 1);
3762         match events_2[0] {
3763                 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id: _ } => {
3764                         assert_eq!(payment_hash_1, *payment_hash);
3765                         assert_eq!(amount_msat, 1_000_000);
3766                         assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
3767                         assert_eq!(via_channel_id, Some(channel_id));
3768                         match &purpose {
3769                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3770                                         assert!(payment_preimage.is_none());
3771                                         assert_eq!(payment_secret_1, *payment_secret);
3772                                 },
3773                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
3774                         }
3775                 },
3776                 _ => panic!("Unexpected event"),
3777         }
3778
3779         nodes[1].node.claim_funds(payment_preimage_1);
3780         check_added_monitors!(nodes[1], 1);
3781         expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
3782
3783         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3784         assert_eq!(events_3.len(), 1);
3785         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3786                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3787                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3788                         assert!(updates.update_add_htlcs.is_empty());
3789                         assert!(updates.update_fail_htlcs.is_empty());
3790                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3791                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3792                         assert!(updates.update_fee.is_none());
3793                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3794                 },
3795                 _ => panic!("Unexpected event"),
3796         };
3797
3798         if messages_delivered >= 1 {
3799                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3800
3801                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3802                 assert_eq!(events_4.len(), 1);
3803                 match events_4[0] {
3804                         Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
3805                                 assert_eq!(payment_preimage_1, *payment_preimage);
3806                                 assert_eq!(payment_hash_1, *payment_hash);
3807                         },
3808                         _ => panic!("Unexpected event"),
3809                 }
3810
3811                 if messages_delivered >= 2 {
3812                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3813                         check_added_monitors!(nodes[0], 1);
3814                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3815
3816                         if messages_delivered >= 3 {
3817                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3818                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3819                                 check_added_monitors!(nodes[1], 1);
3820
3821                                 if messages_delivered >= 4 {
3822                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3823                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3824                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3825                                         check_added_monitors!(nodes[1], 1);
3826
3827                                         if messages_delivered >= 5 {
3828                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3829                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3830                                                 check_added_monitors!(nodes[0], 1);
3831                                         }
3832                                 }
3833                         }
3834                 }
3835         }
3836
3837         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3838         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
3839         if messages_delivered < 2 {
3840                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3841                 if messages_delivered < 1 {
3842                         expect_payment_sent!(nodes[0], payment_preimage_1);
3843                 } else {
3844                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3845                 }
3846         } else if messages_delivered == 2 {
3847                 // nodes[0] still wants its RAA + commitment_signed
3848                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3849         } else if messages_delivered == 3 {
3850                 // nodes[0] still wants its commitment_signed
3851                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3852         } else if messages_delivered == 4 {
3853                 // nodes[1] still wants its final RAA
3854                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3855         } else if messages_delivered == 5 {
3856                 // Everything was delivered...
3857                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3858         }
3859
3860         if messages_delivered == 1 || messages_delivered == 2 {
3861                 expect_payment_path_successful!(nodes[0]);
3862         }
3863         if messages_delivered <= 5 {
3864                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3865                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
3866         }
3867         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3868
3869         if messages_delivered > 2 {
3870                 expect_payment_path_successful!(nodes[0]);
3871         }
3872
3873         // Channel should still work fine...
3874         let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
3875         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3876         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3877 }
3878
3879 #[test]
3880 fn test_drop_messages_peer_disconnect_a() {
3881         do_test_drop_messages_peer_disconnect(0, true);
3882         do_test_drop_messages_peer_disconnect(0, false);
3883         do_test_drop_messages_peer_disconnect(1, false);
3884         do_test_drop_messages_peer_disconnect(2, false);
3885 }
3886
3887 #[test]
3888 fn test_drop_messages_peer_disconnect_b() {
3889         do_test_drop_messages_peer_disconnect(3, false);
3890         do_test_drop_messages_peer_disconnect(4, false);
3891         do_test_drop_messages_peer_disconnect(5, false);
3892         do_test_drop_messages_peer_disconnect(6, false);
3893 }
3894
3895 #[test]
3896 fn test_channel_ready_without_best_block_updated() {
3897         // Previously, if we were offline when a funding transaction was locked in, and then we came
3898         // back online, calling best_block_updated once followed by transactions_confirmed, we'd not
3899         // generate a channel_ready until a later best_block_updated. This tests that we generate the
3900         // channel_ready immediately instead.
3901         let chanmon_cfgs = create_chanmon_cfgs(2);
3902         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3903         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3904         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3905         *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
3906
3907         let funding_tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 1_000_000, 0);
3908
3909         let conf_height = nodes[0].best_block_info().1 + 1;
3910         connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
3911         let block_txn = [funding_tx];
3912         let conf_txn: Vec<_> = block_txn.iter().enumerate().collect();
3913         let conf_block_header = nodes[0].get_block_header(conf_height);
3914         nodes[0].node.transactions_confirmed(&conf_block_header, &conf_txn[..], conf_height);
3915
3916         // Ensure nodes[0] generates a channel_ready after the transactions_confirmed
3917         let as_channel_ready = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id());
3918         nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &as_channel_ready);
3919 }
3920
3921 #[test]
3922 fn test_drop_messages_peer_disconnect_dual_htlc() {
3923         // Test that we can handle reconnecting when both sides of a channel have pending
3924         // commitment_updates when we disconnect.
3925         let chanmon_cfgs = create_chanmon_cfgs(2);
3926         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3927         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3928         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3929         create_announced_chan_between_nodes(&nodes, 0, 1);
3930
3931         let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
3932
3933         // Now try to send a second payment which will fail to send
3934         let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
3935         nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
3936         check_added_monitors!(nodes[0], 1);
3937
3938         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3939         assert_eq!(events_1.len(), 1);
3940         match events_1[0] {
3941                 MessageSendEvent::UpdateHTLCs { .. } => {},
3942                 _ => panic!("Unexpected event"),
3943         }
3944
3945         nodes[1].node.claim_funds(payment_preimage_1);
3946         expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
3947         check_added_monitors!(nodes[1], 1);
3948
3949         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3950         assert_eq!(events_2.len(), 1);
3951         match events_2[0] {
3952                 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 } } => {
3953                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3954                         assert!(update_add_htlcs.is_empty());
3955                         assert_eq!(update_fulfill_htlcs.len(), 1);
3956                         assert!(update_fail_htlcs.is_empty());
3957                         assert!(update_fail_malformed_htlcs.is_empty());
3958                         assert!(update_fee.is_none());
3959
3960                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3961                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3962                         assert_eq!(events_3.len(), 1);
3963                         match events_3[0] {
3964                                 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
3965                                         assert_eq!(*payment_preimage, payment_preimage_1);
3966                                         assert_eq!(*payment_hash, payment_hash_1);
3967                                 },
3968                                 _ => panic!("Unexpected event"),
3969                         }
3970
3971                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3972                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3973                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3974                         check_added_monitors!(nodes[0], 1);
3975                 },
3976                 _ => panic!("Unexpected event"),
3977         }
3978
3979         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3980         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
3981
3982         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }, true).unwrap();
3983         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3984         assert_eq!(reestablish_1.len(), 1);
3985         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }, false).unwrap();
3986         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3987         assert_eq!(reestablish_2.len(), 1);
3988
3989         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3990         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3991         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3992         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3993
3994         assert!(as_resp.0.is_none());
3995         assert!(bs_resp.0.is_none());
3996
3997         assert!(bs_resp.1.is_none());
3998         assert!(bs_resp.2.is_none());
3999
4000         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4001
4002         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
4003         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
4004         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4005         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4006         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
4007         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
4008         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
4009         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4010         // No commitment_signed so get_event_msg's assert(len == 1) passes
4011         check_added_monitors!(nodes[1], 1);
4012
4013         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
4014         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4015         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4016         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4017         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4018         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4019         assert!(bs_second_commitment_signed.update_fee.is_none());
4020         check_added_monitors!(nodes[1], 1);
4021
4022         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4023         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4024         assert!(as_commitment_signed.update_add_htlcs.is_empty());
4025         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4026         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4027         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4028         assert!(as_commitment_signed.update_fee.is_none());
4029         check_added_monitors!(nodes[0], 1);
4030
4031         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4032         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4033         // No commitment_signed so get_event_msg's assert(len == 1) passes
4034         check_added_monitors!(nodes[0], 1);
4035
4036         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4037         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4038         // No commitment_signed so get_event_msg's assert(len == 1) passes
4039         check_added_monitors!(nodes[1], 1);
4040
4041         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4042         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4043         check_added_monitors!(nodes[1], 1);
4044
4045         expect_pending_htlcs_forwardable!(nodes[1]);
4046
4047         let events_5 = nodes[1].node.get_and_clear_pending_events();
4048         assert_eq!(events_5.len(), 1);
4049         match events_5[0] {
4050                 Event::PaymentClaimable { ref payment_hash, ref purpose, .. } => {
4051                         assert_eq!(payment_hash_2, *payment_hash);
4052                         match &purpose {
4053                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
4054                                         assert!(payment_preimage.is_none());
4055                                         assert_eq!(payment_secret_2, *payment_secret);
4056                                 },
4057                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
4058                         }
4059                 },
4060                 _ => panic!("Unexpected event"),
4061         }
4062
4063         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4064         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4065         check_added_monitors!(nodes[0], 1);
4066
4067         expect_payment_path_successful!(nodes[0]);
4068         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4069 }
4070
4071 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4072         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4073         // to avoid our counterparty failing the channel.
4074         let chanmon_cfgs = create_chanmon_cfgs(2);
4075         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4076         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4077         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4078
4079         create_announced_chan_between_nodes(&nodes, 0, 1);
4080
4081         let our_payment_hash = if send_partial_mpp {
4082                 let (route, our_payment_hash, _, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100000);
4083                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4084                 // indicates there are more HTLCs coming.
4085                 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.
4086                 let payment_id = PaymentId([42; 32]);
4087                 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash, Some(payment_secret), payment_id, &route).unwrap();
4088                 nodes[0].node.send_payment_along_path(&route.paths[0], &route.payment_params, &our_payment_hash, &Some(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[0]).unwrap();
4089                 check_added_monitors!(nodes[0], 1);
4090                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4091                 assert_eq!(events.len(), 1);
4092                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4093                 // hop should *not* yet generate any PaymentClaimable event(s).
4094                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
4095                 our_payment_hash
4096         } else {
4097                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4098         };
4099
4100         let mut block = Block {
4101                 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
4102                 txdata: vec![],
4103         };
4104         connect_block(&nodes[0], &block);
4105         connect_block(&nodes[1], &block);
4106         let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
4107         for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
4108                 block.header.prev_blockhash = block.block_hash();
4109                 connect_block(&nodes[0], &block);
4110                 connect_block(&nodes[1], &block);
4111         }
4112
4113         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
4114
4115         check_added_monitors!(nodes[1], 1);
4116         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4117         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4118         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4119         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4120         assert!(htlc_timeout_updates.update_fee.is_none());
4121
4122         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4123         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4124         // 100_000 msat as u64, followed by the height at which we failed back above
4125         let mut expected_failure_data = (100_000 as u64).to_be_bytes().to_vec();
4126         expected_failure_data.extend_from_slice(&(block_count - 1).to_be_bytes());
4127         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4128 }
4129
4130 #[test]
4131 fn test_htlc_timeout() {
4132         do_test_htlc_timeout(true);
4133         do_test_htlc_timeout(false);
4134 }
4135
4136 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4137         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4138         let chanmon_cfgs = create_chanmon_cfgs(3);
4139         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4140         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4141         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4142         create_announced_chan_between_nodes(&nodes, 0, 1);
4143         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4144
4145         // Make sure all nodes are at the same starting height
4146         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4147         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4148         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4149
4150         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4151         let (route, first_payment_hash, _, first_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[2], 100000);
4152         {
4153                 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret), PaymentId(first_payment_hash.0)).unwrap();
4154         }
4155         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4156         check_added_monitors!(nodes[1], 1);
4157
4158         // Now attempt to route a second payment, which should be placed in the holding cell
4159         let sending_node = if forwarded_htlc { &nodes[0] } else { &nodes[1] };
4160         let (route, second_payment_hash, _, second_payment_secret) = get_route_and_payment_hash!(sending_node, nodes[2], 100000);
4161         sending_node.node.send_payment(&route, second_payment_hash, &Some(second_payment_secret), PaymentId(second_payment_hash.0)).unwrap();
4162         if forwarded_htlc {
4163                 check_added_monitors!(nodes[0], 1);
4164                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4165                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4166                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4167                 expect_pending_htlcs_forwardable!(nodes[1]);
4168         }
4169         check_added_monitors!(nodes[1], 0);
4170
4171         connect_blocks(&nodes[1], TEST_FINAL_CLTV - LATENCY_GRACE_PERIOD_BLOCKS);
4172         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4173         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4174         connect_blocks(&nodes[1], 1);
4175
4176         if forwarded_htlc {
4177                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
4178                 check_added_monitors!(nodes[1], 1);
4179                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4180                 assert_eq!(fail_commit.len(), 1);
4181                 match fail_commit[0] {
4182                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4183                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4184                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4185                         },
4186                         _ => unreachable!(),
4187                 }
4188                 expect_payment_failed_with_update!(nodes[0], second_payment_hash, false, chan_2.0.contents.short_channel_id, false);
4189         } else {
4190                 expect_payment_failed!(nodes[1], second_payment_hash, false);
4191         }
4192 }
4193
4194 #[test]
4195 fn test_holding_cell_htlc_add_timeouts() {
4196         do_test_holding_cell_htlc_add_timeouts(false);
4197         do_test_holding_cell_htlc_add_timeouts(true);
4198 }
4199
4200 macro_rules! check_spendable_outputs {
4201         ($node: expr, $keysinterface: expr) => {
4202                 {
4203                         let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4204                         let mut txn = Vec::new();
4205                         let mut all_outputs = Vec::new();
4206                         let secp_ctx = Secp256k1::new();
4207                         for event in events.drain(..) {
4208                                 match event {
4209                                         Event::SpendableOutputs { mut outputs } => {
4210                                                 for outp in outputs.drain(..) {
4211                                                         txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4212                                                         all_outputs.push(outp);
4213                                                 }
4214                                         },
4215                                         _ => panic!("Unexpected event"),
4216                                 };
4217                         }
4218                         if all_outputs.len() > 1 {
4219                                 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) {
4220                                         txn.push(tx);
4221                                 }
4222                         }
4223                         txn
4224                 }
4225         }
4226 }
4227
4228 #[test]
4229 fn test_claim_sizeable_push_msat() {
4230         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4231         let chanmon_cfgs = create_chanmon_cfgs(2);
4232         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4233         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4234         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4235
4236         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 98_000_000);
4237         nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
4238         check_closed_broadcast!(nodes[1], true);
4239         check_added_monitors!(nodes[1], 1);
4240         check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
4241         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4242         assert_eq!(node_txn.len(), 1);
4243         check_spends!(node_txn[0], chan.3);
4244         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
4245
4246         mine_transaction(&nodes[1], &node_txn[0]);
4247         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4248
4249         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4250         assert_eq!(spend_txn.len(), 1);
4251         assert_eq!(spend_txn[0].input.len(), 1);
4252         check_spends!(spend_txn[0], node_txn[0]);
4253         assert_eq!(spend_txn[0].input[0].sequence.0, BREAKDOWN_TIMEOUT as u32);
4254 }
4255
4256 #[test]
4257 fn test_claim_on_remote_sizeable_push_msat() {
4258         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4259         // to_remote output is encumbered by a P2WPKH
4260         let chanmon_cfgs = create_chanmon_cfgs(2);
4261         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4262         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4263         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4264
4265         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 98_000_000);
4266         nodes[0].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
4267         check_closed_broadcast!(nodes[0], true);
4268         check_added_monitors!(nodes[0], 1);
4269         check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
4270
4271         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4272         assert_eq!(node_txn.len(), 1);
4273         check_spends!(node_txn[0], chan.3);
4274         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
4275
4276         mine_transaction(&nodes[1], &node_txn[0]);
4277         check_closed_broadcast!(nodes[1], true);
4278         check_added_monitors!(nodes[1], 1);
4279         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4280         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4281
4282         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4283         assert_eq!(spend_txn.len(), 1);
4284         check_spends!(spend_txn[0], node_txn[0]);
4285 }
4286
4287 #[test]
4288 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4289         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4290         // to_remote output is encumbered by a P2WPKH
4291
4292         let chanmon_cfgs = create_chanmon_cfgs(2);
4293         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4294         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4295         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4296
4297         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000);
4298         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4299         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4300         assert_eq!(revoked_local_txn[0].input.len(), 1);
4301         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4302
4303         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4304         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4305         check_closed_broadcast!(nodes[1], true);
4306         check_added_monitors!(nodes[1], 1);
4307         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4308
4309         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4310         mine_transaction(&nodes[1], &node_txn[0]);
4311         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4312
4313         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4314         assert_eq!(spend_txn.len(), 3);
4315         check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4316         check_spends!(spend_txn[1], node_txn[0]);
4317         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4318 }
4319
4320 #[test]
4321 fn test_static_spendable_outputs_preimage_tx() {
4322         let chanmon_cfgs = create_chanmon_cfgs(2);
4323         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4324         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4325         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4326
4327         // Create some initial channels
4328         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4329
4330         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 3_000_000);
4331
4332         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4333         assert_eq!(commitment_tx[0].input.len(), 1);
4334         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4335
4336         // Settle A's commitment tx on B's chain
4337         nodes[1].node.claim_funds(payment_preimage);
4338         expect_payment_claimed!(nodes[1], payment_hash, 3_000_000);
4339         check_added_monitors!(nodes[1], 1);
4340         mine_transaction(&nodes[1], &commitment_tx[0]);
4341         check_added_monitors!(nodes[1], 1);
4342         let events = nodes[1].node.get_and_clear_pending_msg_events();
4343         match events[0] {
4344                 MessageSendEvent::UpdateHTLCs { .. } => {},
4345                 _ => panic!("Unexpected event"),
4346         }
4347         match events[1] {
4348                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4349                 _ => panic!("Unexepected event"),
4350         }
4351
4352         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4353         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelMonitor: preimage tx
4354         assert_eq!(node_txn.len(), 1);
4355         check_spends!(node_txn[0], commitment_tx[0]);
4356         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4357
4358         mine_transaction(&nodes[1], &node_txn[0]);
4359         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4360         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4361
4362         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4363         assert_eq!(spend_txn.len(), 1);
4364         check_spends!(spend_txn[0], node_txn[0]);
4365 }
4366
4367 #[test]
4368 fn test_static_spendable_outputs_timeout_tx() {
4369         let chanmon_cfgs = create_chanmon_cfgs(2);
4370         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4371         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4372         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4373
4374         // Create some initial channels
4375         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4376
4377         // Rebalance the network a bit by relaying one payment through all the channels ...
4378         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4379
4380         let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4381
4382         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4383         assert_eq!(commitment_tx[0].input.len(), 1);
4384         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4385
4386         // Settle A's commitment tx on B' chain
4387         mine_transaction(&nodes[1], &commitment_tx[0]);
4388         check_added_monitors!(nodes[1], 1);
4389         let events = nodes[1].node.get_and_clear_pending_msg_events();
4390         match events[0] {
4391                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4392                 _ => panic!("Unexpected event"),
4393         }
4394         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
4395
4396         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4397         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4398         assert_eq!(node_txn.len(), 1); // ChannelMonitor: timeout tx
4399         check_spends!(node_txn[0],  commitment_tx[0].clone());
4400         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4401
4402         mine_transaction(&nodes[1], &node_txn[0]);
4403         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4404         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4405         expect_payment_failed!(nodes[1], our_payment_hash, false);
4406
4407         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4408         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
4409         check_spends!(spend_txn[0], commitment_tx[0]);
4410         check_spends!(spend_txn[1], node_txn[0]);
4411         check_spends!(spend_txn[2], node_txn[0], commitment_tx[0]); // All outputs
4412 }
4413
4414 #[test]
4415 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4416         let chanmon_cfgs = create_chanmon_cfgs(2);
4417         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4418         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4419         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4420
4421         // Create some initial channels
4422         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4423
4424         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4425         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4426         assert_eq!(revoked_local_txn[0].input.len(), 1);
4427         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4428
4429         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4430
4431         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4432         check_closed_broadcast!(nodes[1], true);
4433         check_added_monitors!(nodes[1], 1);
4434         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4435
4436         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4437         assert_eq!(node_txn.len(), 1);
4438         assert_eq!(node_txn[0].input.len(), 2);
4439         check_spends!(node_txn[0], revoked_local_txn[0]);
4440
4441         mine_transaction(&nodes[1], &node_txn[0]);
4442         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4443
4444         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4445         assert_eq!(spend_txn.len(), 1);
4446         check_spends!(spend_txn[0], node_txn[0]);
4447 }
4448
4449 #[test]
4450 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4451         let mut chanmon_cfgs = create_chanmon_cfgs(2);
4452         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
4453         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4454         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4455         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4456
4457         // Create some initial channels
4458         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4459
4460         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4461         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4462         assert_eq!(revoked_local_txn[0].input.len(), 1);
4463         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4464
4465         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4466
4467         // A will generate HTLC-Timeout from revoked commitment tx
4468         mine_transaction(&nodes[0], &revoked_local_txn[0]);
4469         check_closed_broadcast!(nodes[0], true);
4470         check_added_monitors!(nodes[0], 1);
4471         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
4472         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
4473
4474         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4475         assert_eq!(revoked_htlc_txn.len(), 1);
4476         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4477         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4478         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4479         assert_ne!(revoked_htlc_txn[0].lock_time.0, 0); // HTLC-Timeout
4480
4481         // B will generate justice tx from A's revoked commitment/HTLC tx
4482         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
4483         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
4484         check_closed_broadcast!(nodes[1], true);
4485         check_added_monitors!(nodes[1], 1);
4486         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4487
4488         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4489         assert_eq!(node_txn.len(), 2); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs
4490         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4491         // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
4492         // transactions next...
4493         assert_eq!(node_txn[0].input.len(), 3);
4494         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4495
4496         assert_eq!(node_txn[1].input.len(), 2);
4497         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[0]);
4498         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4499                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4500         } else {
4501                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
4502                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4503         }
4504
4505         mine_transaction(&nodes[1], &node_txn[1]);
4506         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4507
4508         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4509         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4510         assert_eq!(spend_txn.len(), 1);
4511         assert_eq!(spend_txn[0].input.len(), 1);
4512         check_spends!(spend_txn[0], node_txn[1]);
4513 }
4514
4515 #[test]
4516 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4517         let mut chanmon_cfgs = create_chanmon_cfgs(2);
4518         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
4519         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4520         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4521         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4522
4523         // Create some initial channels
4524         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4525
4526         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4527         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4528         assert_eq!(revoked_local_txn[0].input.len(), 1);
4529         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4530
4531         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
4532         assert_eq!(revoked_local_txn[0].output.len(), 2);
4533
4534         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4535
4536         // B will generate HTLC-Success from revoked commitment tx
4537         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4538         check_closed_broadcast!(nodes[1], true);
4539         check_added_monitors!(nodes[1], 1);
4540         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4541         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4542
4543         assert_eq!(revoked_htlc_txn.len(), 1);
4544         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4545         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4546         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4547
4548         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
4549         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
4550         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
4551
4552         // A will generate justice tx from B's revoked commitment/HTLC tx
4553         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
4554         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
4555         check_closed_broadcast!(nodes[0], true);
4556         check_added_monitors!(nodes[0], 1);
4557         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
4558
4559         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4560         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success
4561
4562         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4563         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
4564         // transactions next...
4565         assert_eq!(node_txn[0].input.len(), 2);
4566         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4567         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4568                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4569         } else {
4570                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
4571                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4572         }
4573
4574         assert_eq!(node_txn[1].input.len(), 1);
4575         check_spends!(node_txn[1], revoked_htlc_txn[0]);
4576
4577         mine_transaction(&nodes[0], &node_txn[1]);
4578         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
4579
4580         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
4581         // didn't try to generate any new transactions.
4582
4583         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4584         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
4585         assert_eq!(spend_txn.len(), 3);
4586         assert_eq!(spend_txn[0].input.len(), 1);
4587         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
4588         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4589         check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
4590         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
4591 }
4592
4593 #[test]
4594 fn test_onchain_to_onchain_claim() {
4595         // Test that in case of channel closure, we detect the state of output and claim HTLC
4596         // on downstream peer's remote commitment tx.
4597         // First, have C claim an HTLC against its own latest commitment transaction.
4598         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4599         // channel.
4600         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4601         // gets broadcast.
4602
4603         let chanmon_cfgs = create_chanmon_cfgs(3);
4604         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4605         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4606         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4607
4608         // Create some initial channels
4609         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4610         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4611
4612         // Ensure all nodes are at the same height
4613         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
4614         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
4615         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
4616         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
4617
4618         // Rebalance the network a bit by relaying one payment through all the channels ...
4619         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
4620         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
4621
4622         let (payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3_000_000);
4623         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
4624         check_spends!(commitment_tx[0], chan_2.3);
4625         nodes[2].node.claim_funds(payment_preimage);
4626         expect_payment_claimed!(nodes[2], payment_hash, 3_000_000);
4627         check_added_monitors!(nodes[2], 1);
4628         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4629         assert!(updates.update_add_htlcs.is_empty());
4630         assert!(updates.update_fail_htlcs.is_empty());
4631         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4632         assert!(updates.update_fail_malformed_htlcs.is_empty());
4633
4634         mine_transaction(&nodes[2], &commitment_tx[0]);
4635         check_closed_broadcast!(nodes[2], true);
4636         check_added_monitors!(nodes[2], 1);
4637         check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
4638
4639         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelMonitor: 1 (HTLC-Success tx)
4640         assert_eq!(c_txn.len(), 1);
4641         check_spends!(c_txn[0], commitment_tx[0]);
4642         assert_eq!(c_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4643         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4644         assert_eq!(c_txn[0].lock_time.0, 0); // Success tx
4645
4646         // 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
4647         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42};
4648         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone(), c_txn[0].clone()]});
4649         check_added_monitors!(nodes[1], 1);
4650         let events = nodes[1].node.get_and_clear_pending_events();
4651         assert_eq!(events.len(), 2);
4652         match events[0] {
4653                 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
4654                 _ => panic!("Unexpected event"),
4655         }
4656         match events[1] {
4657                 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
4658                         assert_eq!(fee_earned_msat, Some(1000));
4659                         assert_eq!(prev_channel_id, Some(chan_1.2));
4660                         assert_eq!(claim_from_onchain_tx, true);
4661                         assert_eq!(next_channel_id, Some(chan_2.2));
4662                 },
4663                 _ => panic!("Unexpected event"),
4664         }
4665         check_added_monitors!(nodes[1], 1);
4666         let mut msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4667         assert_eq!(msg_events.len(), 3);
4668         let nodes_2_event = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut msg_events);
4669         let nodes_0_event = remove_first_msg_event_to_node(&nodes[0].node.get_our_node_id(), &mut msg_events);
4670
4671         match nodes_2_event {
4672                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
4673                 _ => panic!("Unexpected event"),
4674         }
4675
4676         match nodes_0_event {
4677                 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, .. } } => {
4678                         assert!(update_add_htlcs.is_empty());
4679                         assert!(update_fail_htlcs.is_empty());
4680                         assert_eq!(update_fulfill_htlcs.len(), 1);
4681                         assert!(update_fail_malformed_htlcs.is_empty());
4682                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
4683                 },
4684                 _ => panic!("Unexpected event"),
4685         };
4686
4687         // Ensure that the last remaining message event is the BroadcastChannelUpdate msg for chan_2
4688         match msg_events[0] {
4689                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4690                 _ => panic!("Unexpected event"),
4691         }
4692
4693         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
4694         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4695         mine_transaction(&nodes[1], &commitment_tx[0]);
4696         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4697         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4698         // ChannelMonitor: HTLC-Success tx
4699         assert_eq!(b_txn.len(), 1);
4700         check_spends!(b_txn[0], commitment_tx[0]);
4701         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4702         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4703         assert_eq!(b_txn[0].lock_time.0, 0); // Success tx
4704
4705         check_closed_broadcast!(nodes[1], true);
4706         check_added_monitors!(nodes[1], 1);
4707 }
4708
4709 #[test]
4710 fn test_duplicate_payment_hash_one_failure_one_success() {
4711         // Topology : A --> B --> C --> D
4712         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
4713         // Note that because C will refuse to generate two payment secrets for the same payment hash,
4714         // we forward one of the payments onwards to D.
4715         let chanmon_cfgs = create_chanmon_cfgs(4);
4716         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4717         // When this test was written, the default base fee floated based on the HTLC count.
4718         // It is now fixed, so we simply set the fee to the expected value here.
4719         let mut config = test_default_channel_config();
4720         config.channel_config.forwarding_fee_base_msat = 196;
4721         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs,
4722                 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
4723         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4724
4725         create_announced_chan_between_nodes(&nodes, 0, 1);
4726         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4727         create_announced_chan_between_nodes(&nodes, 2, 3);
4728
4729         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
4730         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
4731         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
4732         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
4733         connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
4734
4735         let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 900_000);
4736
4737         let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, None).unwrap();
4738         // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
4739         // script push size limit so that the below script length checks match
4740         // ACCEPTED_HTLC_SCRIPT_WEIGHT.
4741         let payment_params = PaymentParameters::from_node_id(nodes[3].node.get_our_node_id(), TEST_FINAL_CLTV - 40)
4742                 .with_features(nodes[3].node.invoice_features());
4743         let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[3], payment_params, 800_000, TEST_FINAL_CLTV - 40);
4744         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 800_000, duplicate_payment_hash, payment_secret);
4745
4746         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
4747         assert_eq!(commitment_txn[0].input.len(), 1);
4748         check_spends!(commitment_txn[0], chan_2.3);
4749
4750         mine_transaction(&nodes[1], &commitment_txn[0]);
4751         check_closed_broadcast!(nodes[1], true);
4752         check_added_monitors!(nodes[1], 1);
4753         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4754         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
4755
4756         let htlc_timeout_tx;
4757         { // Extract one of the two HTLC-Timeout transaction
4758                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4759                 // ChannelMonitor: timeout tx * 2-or-3
4760                 assert!(node_txn.len() == 2 || node_txn.len() == 3);
4761
4762                 check_spends!(node_txn[0], commitment_txn[0]);
4763                 assert_eq!(node_txn[0].input.len(), 1);
4764                 assert_eq!(node_txn[0].output.len(), 1);
4765
4766                 if node_txn.len() > 2 {
4767                         check_spends!(node_txn[1], commitment_txn[0]);
4768                         assert_eq!(node_txn[1].input.len(), 1);
4769                         assert_eq!(node_txn[1].output.len(), 1);
4770                         assert_eq!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
4771
4772                         check_spends!(node_txn[2], commitment_txn[0]);
4773                         assert_eq!(node_txn[2].input.len(), 1);
4774                         assert_eq!(node_txn[2].output.len(), 1);
4775                         assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
4776                 } else {
4777                         check_spends!(node_txn[1], commitment_txn[0]);
4778                         assert_eq!(node_txn[1].input.len(), 1);
4779                         assert_eq!(node_txn[1].output.len(), 1);
4780                         assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
4781                 }
4782
4783                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4784                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4785                 // Assign htlc_timeout_tx to the forwarded HTLC (with value ~800 sats). The received HTLC
4786                 // (with value 900 sats) will be claimed in the below `claim_funds` call.
4787                 if node_txn.len() > 2 {
4788                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4789                         htlc_timeout_tx = if node_txn[2].output[0].value < 900 { node_txn[2].clone() } else { node_txn[0].clone() };
4790                 } else {
4791                         htlc_timeout_tx = if node_txn[0].output[0].value < 900 { node_txn[1].clone() } else { node_txn[0].clone() };
4792                 }
4793         }
4794
4795         nodes[2].node.claim_funds(our_payment_preimage);
4796         expect_payment_claimed!(nodes[2], duplicate_payment_hash, 900_000);
4797
4798         mine_transaction(&nodes[2], &commitment_txn[0]);
4799         check_added_monitors!(nodes[2], 2);
4800         check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
4801         let events = nodes[2].node.get_and_clear_pending_msg_events();
4802         match events[0] {
4803                 MessageSendEvent::UpdateHTLCs { .. } => {},
4804                 _ => panic!("Unexpected event"),
4805         }
4806         match events[1] {
4807                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4808                 _ => panic!("Unexepected event"),
4809         }
4810         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4811         assert_eq!(htlc_success_txn.len(), 2); // ChannelMonitor: HTLC-Success txn (*2 due to 2-HTLC outputs)
4812         check_spends!(htlc_success_txn[0], commitment_txn[0]);
4813         check_spends!(htlc_success_txn[1], commitment_txn[0]);
4814         assert_eq!(htlc_success_txn[0].input.len(), 1);
4815         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4816         assert_eq!(htlc_success_txn[1].input.len(), 1);
4817         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4818         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
4819         assert_ne!(htlc_success_txn[1].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
4820
4821         mine_transaction(&nodes[1], &htlc_timeout_tx);
4822         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4823         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
4824         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4825         assert!(htlc_updates.update_add_htlcs.is_empty());
4826         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4827         let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
4828         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4829         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4830         check_added_monitors!(nodes[1], 1);
4831
4832         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4833         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4834         {
4835                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
4836         }
4837         expect_payment_failed_with_update!(nodes[0], duplicate_payment_hash, false, chan_2.0.contents.short_channel_id, true);
4838
4839         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
4840         mine_transaction(&nodes[1], &htlc_success_txn[1]);
4841         expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(196), true, true);
4842         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4843         assert!(updates.update_add_htlcs.is_empty());
4844         assert!(updates.update_fail_htlcs.is_empty());
4845         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4846         assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
4847         assert!(updates.update_fail_malformed_htlcs.is_empty());
4848         check_added_monitors!(nodes[1], 1);
4849
4850         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
4851         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
4852
4853         let events = nodes[0].node.get_and_clear_pending_events();
4854         match events[0] {
4855                 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
4856                         assert_eq!(*payment_preimage, our_payment_preimage);
4857                         assert_eq!(*payment_hash, duplicate_payment_hash);
4858                 }
4859                 _ => panic!("Unexpected event"),
4860         }
4861 }
4862
4863 #[test]
4864 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
4865         let chanmon_cfgs = create_chanmon_cfgs(2);
4866         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4867         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4868         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4869
4870         // Create some initial channels
4871         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4872
4873         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 9_000_000);
4874         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4875         assert_eq!(local_txn.len(), 1);
4876         assert_eq!(local_txn[0].input.len(), 1);
4877         check_spends!(local_txn[0], chan_1.3);
4878
4879         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
4880         nodes[1].node.claim_funds(payment_preimage);
4881         expect_payment_claimed!(nodes[1], payment_hash, 9_000_000);
4882         check_added_monitors!(nodes[1], 1);
4883
4884         mine_transaction(&nodes[1], &local_txn[0]);
4885         check_added_monitors!(nodes[1], 1);
4886         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4887         let events = nodes[1].node.get_and_clear_pending_msg_events();
4888         match events[0] {
4889                 MessageSendEvent::UpdateHTLCs { .. } => {},
4890                 _ => panic!("Unexpected event"),
4891         }
4892         match events[1] {
4893                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4894                 _ => panic!("Unexepected event"),
4895         }
4896         let node_tx = {
4897                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4898                 assert_eq!(node_txn.len(), 1);
4899                 assert_eq!(node_txn[0].input.len(), 1);
4900                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4901                 check_spends!(node_txn[0], local_txn[0]);
4902                 node_txn[0].clone()
4903         };
4904
4905         mine_transaction(&nodes[1], &node_tx);
4906         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4907
4908         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
4909         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4910         assert_eq!(spend_txn.len(), 1);
4911         assert_eq!(spend_txn[0].input.len(), 1);
4912         check_spends!(spend_txn[0], node_tx);
4913         assert_eq!(spend_txn[0].input[0].sequence.0, BREAKDOWN_TIMEOUT as u32);
4914 }
4915
4916 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
4917         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
4918         // unrevoked commitment transaction.
4919         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
4920         // a remote RAA before they could be failed backwards (and combinations thereof).
4921         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
4922         // use the same payment hashes.
4923         // Thus, we use a six-node network:
4924         //
4925         // A \         / E
4926         //    - C - D -
4927         // B /         \ F
4928         // And test where C fails back to A/B when D announces its latest commitment transaction
4929         let chanmon_cfgs = create_chanmon_cfgs(6);
4930         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
4931         // When this test was written, the default base fee floated based on the HTLC count.
4932         // It is now fixed, so we simply set the fee to the expected value here.
4933         let mut config = test_default_channel_config();
4934         config.channel_config.forwarding_fee_base_msat = 196;
4935         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs,
4936                 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
4937         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
4938
4939         let _chan_0_2 = create_announced_chan_between_nodes(&nodes, 0, 2);
4940         let _chan_1_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4941         let chan_2_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
4942         let chan_3_4 = create_announced_chan_between_nodes(&nodes, 3, 4);
4943         let chan_3_5  = create_announced_chan_between_nodes(&nodes, 3, 5);
4944
4945         // Rebalance and check output sanity...
4946         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
4947         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
4948         assert_eq!(get_local_commitment_txn!(nodes[3], chan_2_3.2)[0].output.len(), 2);
4949
4950         let ds_dust_limit = nodes[3].node.per_peer_state.read().unwrap().get(&nodes[2].node.get_our_node_id())
4951                 .unwrap().lock().unwrap().channel_by_id.get(&chan_2_3.2).unwrap().holder_dust_limit_satoshis;
4952         // 0th HTLC:
4953         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
4954         // 1st HTLC:
4955         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
4956         let (route, _, _, _) = get_route_and_payment_hash!(nodes[1], nodes[5], ds_dust_limit*1000);
4957         // 2nd HTLC:
4958         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, None).unwrap()); // not added < dust limit + HTLC tx fee
4959         // 3rd HTLC:
4960         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, None).unwrap()); // not added < dust limit + HTLC tx fee
4961         // 4th HTLC:
4962         let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4963         // 5th HTLC:
4964         let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4965         let (route, _, _, _) = get_route_and_payment_hash!(nodes[1], nodes[5], 1000000);
4966         // 6th HTLC:
4967         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, None).unwrap());
4968         // 7th HTLC:
4969         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, None).unwrap());
4970
4971         // 8th HTLC:
4972         let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4973         // 9th HTLC:
4974         let (route, _, _, _) = get_route_and_payment_hash!(nodes[1], nodes[5], ds_dust_limit*1000);
4975         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, None).unwrap()); // not added < dust limit + HTLC tx fee
4976
4977         // 10th HTLC:
4978         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
4979         // 11th HTLC:
4980         let (route, _, _, _) = get_route_and_payment_hash!(nodes[1], nodes[5], 1000000);
4981         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, None).unwrap());
4982
4983         // Double-check that six of the new HTLC were added
4984         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
4985         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
4986         assert_eq!(get_local_commitment_txn!(nodes[3], chan_2_3.2).len(), 1);
4987         assert_eq!(get_local_commitment_txn!(nodes[3], chan_2_3.2)[0].output.len(), 8);
4988
4989         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
4990         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
4991         nodes[4].node.fail_htlc_backwards(&payment_hash_1);
4992         nodes[4].node.fail_htlc_backwards(&payment_hash_3);
4993         nodes[4].node.fail_htlc_backwards(&payment_hash_5);
4994         nodes[4].node.fail_htlc_backwards(&payment_hash_6);
4995         check_added_monitors!(nodes[4], 0);
4996
4997         let failed_destinations = vec![
4998                 HTLCDestination::FailedPayment { payment_hash: payment_hash_1 },
4999                 HTLCDestination::FailedPayment { payment_hash: payment_hash_3 },
5000                 HTLCDestination::FailedPayment { payment_hash: payment_hash_5 },
5001                 HTLCDestination::FailedPayment { payment_hash: payment_hash_6 },
5002         ];
5003         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[4], failed_destinations);
5004         check_added_monitors!(nodes[4], 1);
5005
5006         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5007         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5008         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5009         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5010         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5011         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5012
5013         // Fail 3rd below-dust and 7th above-dust HTLCs
5014         nodes[5].node.fail_htlc_backwards(&payment_hash_2);
5015         nodes[5].node.fail_htlc_backwards(&payment_hash_4);
5016         check_added_monitors!(nodes[5], 0);
5017
5018         let failed_destinations_2 = vec![
5019                 HTLCDestination::FailedPayment { payment_hash: payment_hash_2 },
5020                 HTLCDestination::FailedPayment { payment_hash: payment_hash_4 },
5021         ];
5022         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[5], failed_destinations_2);
5023         check_added_monitors!(nodes[5], 1);
5024
5025         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5026         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5027         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5028         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5029
5030         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan_2_3.2);
5031
5032         // After 4 and 2 removes respectively above in nodes[4] and nodes[5], nodes[3] should receive 6 PaymentForwardedFailed events
5033         let failed_destinations_3 = vec![
5034                 HTLCDestination::NextHopChannel { node_id: Some(nodes[4].node.get_our_node_id()), channel_id: chan_3_4.2 },
5035                 HTLCDestination::NextHopChannel { node_id: Some(nodes[4].node.get_our_node_id()), channel_id: chan_3_4.2 },
5036                 HTLCDestination::NextHopChannel { node_id: Some(nodes[4].node.get_our_node_id()), channel_id: chan_3_4.2 },
5037                 HTLCDestination::NextHopChannel { node_id: Some(nodes[4].node.get_our_node_id()), channel_id: chan_3_4.2 },
5038                 HTLCDestination::NextHopChannel { node_id: Some(nodes[5].node.get_our_node_id()), channel_id: chan_3_5.2 },
5039                 HTLCDestination::NextHopChannel { node_id: Some(nodes[5].node.get_our_node_id()), channel_id: chan_3_5.2 },
5040         ];
5041         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[3], failed_destinations_3);
5042         check_added_monitors!(nodes[3], 1);
5043         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5044         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5045         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5046         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5047         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5048         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5049         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5050         if deliver_last_raa {
5051                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5052         } else {
5053                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5054         }
5055
5056         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5057         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5058         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5059         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5060         //
5061         // We now broadcast the latest commitment transaction, which *should* result in failures for
5062         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5063         // the non-broadcast above-dust HTLCs.
5064         //
5065         // Alternatively, we may broadcast the previous commitment transaction, which should only
5066         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5067         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan_2_3.2);
5068
5069         if announce_latest {
5070                 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5071         } else {
5072                 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5073         }
5074         let events = nodes[2].node.get_and_clear_pending_events();
5075         let close_event = if deliver_last_raa {
5076                 assert_eq!(events.len(), 2 + 6);
5077                 events.last().clone().unwrap()
5078         } else {
5079                 assert_eq!(events.len(), 1);
5080                 events.last().clone().unwrap()
5081         };
5082         match close_event {
5083                 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
5084                 _ => panic!("Unexpected event"),
5085         }
5086
5087         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5088         check_closed_broadcast!(nodes[2], true);
5089         if deliver_last_raa {
5090                 expect_pending_htlcs_forwardable_from_events!(nodes[2], events[0..1], true);
5091
5092                 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::NextHopChannel { node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_2_3.2 }).take(3).collect();
5093                 expect_htlc_handling_failed_destinations!(nodes[2].node.get_and_clear_pending_events(), expected_destinations);
5094         } else {
5095                 let expected_destinations: Vec<HTLCDestination> = if announce_latest {
5096                         repeat(HTLCDestination::NextHopChannel { node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_2_3.2 }).take(9).collect()
5097                 } else {
5098                         repeat(HTLCDestination::NextHopChannel { node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_2_3.2 }).take(6).collect()
5099                 };
5100
5101                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], expected_destinations);
5102         }
5103         check_added_monitors!(nodes[2], 3);
5104
5105         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5106         assert_eq!(cs_msgs.len(), 2);
5107         let mut a_done = false;
5108         for msg in cs_msgs {
5109                 match msg {
5110                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5111                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5112                                 // should be failed-backwards here.
5113                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5114                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5115                                         for htlc in &updates.update_fail_htlcs {
5116                                                 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 });
5117                                         }
5118                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5119                                         assert!(!a_done);
5120                                         a_done = true;
5121                                         &nodes[0]
5122                                 } else {
5123                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5124                                         for htlc in &updates.update_fail_htlcs {
5125                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5126                                         }
5127                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5128                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5129                                         &nodes[1]
5130                                 };
5131                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5132                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5133                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5134                                 if announce_latest {
5135                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5136                                         if *node_id == nodes[0].node.get_our_node_id() {
5137                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5138                                         }
5139                                 }
5140                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5141                         },
5142                         _ => panic!("Unexpected event"),
5143                 }
5144         }
5145
5146         let as_events = nodes[0].node.get_and_clear_pending_events();
5147         assert_eq!(as_events.len(), if announce_latest { 10 } else { 6 });
5148         let mut as_failds = HashSet::new();
5149         let mut as_updates = 0;
5150         for event in as_events.iter() {
5151                 if let &Event::PaymentPathFailed { ref payment_hash, ref payment_failed_permanently, ref network_update, .. } = event {
5152                         assert!(as_failds.insert(*payment_hash));
5153                         if *payment_hash != payment_hash_2 {
5154                                 assert_eq!(*payment_failed_permanently, deliver_last_raa);
5155                         } else {
5156                                 assert!(!payment_failed_permanently);
5157                         }
5158                         if network_update.is_some() {
5159                                 as_updates += 1;
5160                         }
5161                 } else if let &Event::PaymentFailed { .. } = event {
5162                 } else { panic!("Unexpected event"); }
5163         }
5164         assert!(as_failds.contains(&payment_hash_1));
5165         assert!(as_failds.contains(&payment_hash_2));
5166         if announce_latest {
5167                 assert!(as_failds.contains(&payment_hash_3));
5168                 assert!(as_failds.contains(&payment_hash_5));
5169         }
5170         assert!(as_failds.contains(&payment_hash_6));
5171
5172         let bs_events = nodes[1].node.get_and_clear_pending_events();
5173         assert_eq!(bs_events.len(), if announce_latest { 8 } else { 6 });
5174         let mut bs_failds = HashSet::new();
5175         let mut bs_updates = 0;
5176         for event in bs_events.iter() {
5177                 if let &Event::PaymentPathFailed { ref payment_hash, ref payment_failed_permanently, ref network_update, .. } = event {
5178                         assert!(bs_failds.insert(*payment_hash));
5179                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5180                                 assert_eq!(*payment_failed_permanently, deliver_last_raa);
5181                         } else {
5182                                 assert!(!payment_failed_permanently);
5183                         }
5184                         if network_update.is_some() {
5185                                 bs_updates += 1;
5186                         }
5187                 } else if let &Event::PaymentFailed { .. } = event {
5188                 } else { panic!("Unexpected event"); }
5189         }
5190         assert!(bs_failds.contains(&payment_hash_1));
5191         assert!(bs_failds.contains(&payment_hash_2));
5192         if announce_latest {
5193                 assert!(bs_failds.contains(&payment_hash_4));
5194         }
5195         assert!(bs_failds.contains(&payment_hash_5));
5196
5197         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5198         // get a NetworkUpdate. A should have gotten 4 HTLCs which were failed-back due to
5199         // unknown-preimage-etc, B should have gotten 2. Thus, in the
5200         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2 NetworkUpdates.
5201         assert_eq!(as_updates, if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5202         assert_eq!(bs_updates, if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5203 }
5204
5205 #[test]
5206 fn test_fail_backwards_latest_remote_announce_a() {
5207         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5208 }
5209
5210 #[test]
5211 fn test_fail_backwards_latest_remote_announce_b() {
5212         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5213 }
5214
5215 #[test]
5216 fn test_fail_backwards_previous_remote_announce() {
5217         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5218         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5219         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5220 }
5221
5222 #[test]
5223 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5224         let chanmon_cfgs = create_chanmon_cfgs(2);
5225         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5226         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5227         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5228
5229         // Create some initial channels
5230         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5231
5232         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5233         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5234         assert_eq!(local_txn[0].input.len(), 1);
5235         check_spends!(local_txn[0], chan_1.3);
5236
5237         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5238         mine_transaction(&nodes[0], &local_txn[0]);
5239         check_closed_broadcast!(nodes[0], true);
5240         check_added_monitors!(nodes[0], 1);
5241         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
5242         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5243
5244         let htlc_timeout = {
5245                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5246                 assert_eq!(node_txn.len(), 1);
5247                 assert_eq!(node_txn[0].input.len(), 1);
5248                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5249                 check_spends!(node_txn[0], local_txn[0]);
5250                 node_txn[0].clone()
5251         };
5252
5253         mine_transaction(&nodes[0], &htlc_timeout);
5254         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5255         expect_payment_failed!(nodes[0], our_payment_hash, false);
5256
5257         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5258         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5259         assert_eq!(spend_txn.len(), 3);
5260         check_spends!(spend_txn[0], local_txn[0]);
5261         assert_eq!(spend_txn[1].input.len(), 1);
5262         check_spends!(spend_txn[1], htlc_timeout);
5263         assert_eq!(spend_txn[1].input[0].sequence.0, BREAKDOWN_TIMEOUT as u32);
5264         assert_eq!(spend_txn[2].input.len(), 2);
5265         check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5266         assert!(spend_txn[2].input[0].sequence.0 == BREAKDOWN_TIMEOUT as u32 ||
5267                 spend_txn[2].input[1].sequence.0 == BREAKDOWN_TIMEOUT as u32);
5268 }
5269
5270 #[test]
5271 fn test_key_derivation_params() {
5272         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with a key
5273         // manager rotation to test that `channel_keys_id` returned in
5274         // [`SpendableOutputDescriptor::DelayedPaymentOutput`] let us re-derive the channel key set to
5275         // then derive a `delayed_payment_key`.
5276
5277         let chanmon_cfgs = create_chanmon_cfgs(3);
5278
5279         // We manually create the node configuration to backup the seed.
5280         let seed = [42; 32];
5281         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5282         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);
5283         let network_graph = Arc::new(NetworkGraph::new(chanmon_cfgs[0].chain_source.genesis_hash, &chanmon_cfgs[0].logger));
5284         let scorer = Mutex::new(test_utils::TestScorer::new());
5285         let router = test_utils::TestRouter::new(network_graph.clone(), &scorer);
5286         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, router, chain_monitor, keys_manager: &keys_manager, network_graph, node_seed: seed, override_init_features: alloc::rc::Rc::new(core::cell::RefCell::new(None)) };
5287         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5288         node_cfgs.remove(0);
5289         node_cfgs.insert(0, node);
5290
5291         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5292         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5293
5294         // Create some initial channels
5295         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5296         // for node 0
5297         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2);
5298         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5299         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5300
5301         // Ensure all nodes are at the same height
5302         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5303         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5304         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5305         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5306
5307         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5308         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5309         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5310         assert_eq!(local_txn_1[0].input.len(), 1);
5311         check_spends!(local_txn_1[0], chan_1.3);
5312
5313         // We check funding pubkey are unique
5314         let (from_0_funding_key_0, from_0_funding_key_1) = (PublicKey::from_slice(&local_txn_0[0].input[0].witness.to_vec()[3][2..35]), PublicKey::from_slice(&local_txn_0[0].input[0].witness.to_vec()[3][36..69]));
5315         let (from_1_funding_key_0, from_1_funding_key_1) = (PublicKey::from_slice(&local_txn_1[0].input[0].witness.to_vec()[3][2..35]), PublicKey::from_slice(&local_txn_1[0].input[0].witness.to_vec()[3][36..69]));
5316         if from_0_funding_key_0 == from_1_funding_key_0
5317             || from_0_funding_key_0 == from_1_funding_key_1
5318             || from_0_funding_key_1 == from_1_funding_key_0
5319             || from_0_funding_key_1 == from_1_funding_key_1 {
5320                 panic!("Funding pubkeys aren't unique");
5321         }
5322
5323         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5324         mine_transaction(&nodes[0], &local_txn_1[0]);
5325         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5326         check_closed_broadcast!(nodes[0], true);
5327         check_added_monitors!(nodes[0], 1);
5328         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
5329
5330         let htlc_timeout = {
5331                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5332                 assert_eq!(node_txn.len(), 1);
5333                 assert_eq!(node_txn[0].input.len(), 1);
5334                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5335                 check_spends!(node_txn[0], local_txn_1[0]);
5336                 node_txn[0].clone()
5337         };
5338
5339         mine_transaction(&nodes[0], &htlc_timeout);
5340         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5341         expect_payment_failed!(nodes[0], our_payment_hash, false);
5342
5343         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5344         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5345         let spend_txn = check_spendable_outputs!(nodes[0], new_keys_manager);
5346         assert_eq!(spend_txn.len(), 3);
5347         check_spends!(spend_txn[0], local_txn_1[0]);
5348         assert_eq!(spend_txn[1].input.len(), 1);
5349         check_spends!(spend_txn[1], htlc_timeout);
5350         assert_eq!(spend_txn[1].input[0].sequence.0, BREAKDOWN_TIMEOUT as u32);
5351         assert_eq!(spend_txn[2].input.len(), 2);
5352         check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5353         assert!(spend_txn[2].input[0].sequence.0 == BREAKDOWN_TIMEOUT as u32 ||
5354                 spend_txn[2].input[1].sequence.0 == BREAKDOWN_TIMEOUT as u32);
5355 }
5356
5357 #[test]
5358 fn test_static_output_closing_tx() {
5359         let chanmon_cfgs = create_chanmon_cfgs(2);
5360         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5361         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5362         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5363
5364         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
5365
5366         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5367         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5368
5369         mine_transaction(&nodes[0], &closing_tx);
5370         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
5371         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5372
5373         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5374         assert_eq!(spend_txn.len(), 1);
5375         check_spends!(spend_txn[0], closing_tx);
5376
5377         mine_transaction(&nodes[1], &closing_tx);
5378         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
5379         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5380
5381         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5382         assert_eq!(spend_txn.len(), 1);
5383         check_spends!(spend_txn[0], closing_tx);
5384 }
5385
5386 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5387         let chanmon_cfgs = create_chanmon_cfgs(2);
5388         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5389         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5390         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5391         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
5392
5393         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3_000_000 });
5394
5395         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5396         // present in B's local commitment transaction, but none of A's commitment transactions.
5397         nodes[1].node.claim_funds(payment_preimage);
5398         check_added_monitors!(nodes[1], 1);
5399         expect_payment_claimed!(nodes[1], payment_hash, if use_dust { 50000 } else { 3_000_000 });
5400
5401         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5402         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5403         expect_payment_sent_without_paths!(nodes[0], payment_preimage);
5404
5405         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5406         check_added_monitors!(nodes[0], 1);
5407         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5408         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5409         check_added_monitors!(nodes[1], 1);
5410
5411         let starting_block = nodes[1].best_block_info();
5412         let mut block = Block {
5413                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
5414                 txdata: vec![],
5415         };
5416         for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5417                 connect_block(&nodes[1], &block);
5418                 block.header.prev_blockhash = block.block_hash();
5419         }
5420         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5421         check_closed_broadcast!(nodes[1], true);
5422         check_added_monitors!(nodes[1], 1);
5423         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
5424 }
5425
5426 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5427         let chanmon_cfgs = create_chanmon_cfgs(2);
5428         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5429         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5430         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5431         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
5432
5433         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], if use_dust { 50000 } else { 3000000 });
5434         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
5435         check_added_monitors!(nodes[0], 1);
5436
5437         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5438
5439         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5440         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5441         // to "time out" the HTLC.
5442
5443         let starting_block = nodes[1].best_block_info();
5444         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
5445
5446         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5447                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5448                 header.prev_blockhash = header.block_hash();
5449         }
5450         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5451         check_closed_broadcast!(nodes[0], true);
5452         check_added_monitors!(nodes[0], 1);
5453         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
5454 }
5455
5456 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5457         let chanmon_cfgs = create_chanmon_cfgs(3);
5458         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5459         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5460         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5461         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
5462
5463         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5464         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5465         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5466         // actually revoked.
5467         let htlc_value = if use_dust { 50000 } else { 3000000 };
5468         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5469         nodes[1].node.fail_htlc_backwards(&our_payment_hash);
5470         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
5471         check_added_monitors!(nodes[1], 1);
5472
5473         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5474         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5475         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5476         check_added_monitors!(nodes[0], 1);
5477         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5478         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5479         check_added_monitors!(nodes[1], 1);
5480         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5481         check_added_monitors!(nodes[1], 1);
5482         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5483
5484         if check_revoke_no_close {
5485                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5486                 check_added_monitors!(nodes[0], 1);
5487         }
5488
5489         let starting_block = nodes[1].best_block_info();
5490         let mut block = Block {
5491                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
5492                 txdata: vec![],
5493         };
5494         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
5495                 connect_block(&nodes[0], &block);
5496                 block.header.prev_blockhash = block.block_hash();
5497         }
5498         if !check_revoke_no_close {
5499                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5500                 check_closed_broadcast!(nodes[0], true);
5501                 check_added_monitors!(nodes[0], 1);
5502                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
5503         } else {
5504                 expect_payment_failed!(nodes[0], our_payment_hash, true);
5505         }
5506 }
5507
5508 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5509 // There are only a few cases to test here:
5510 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5511 //    broadcastable commitment transactions result in channel closure,
5512 //  * its included in an unrevoked-but-previous remote commitment transaction,
5513 //  * its included in the latest remote or local commitment transactions.
5514 // We test each of the three possible commitment transactions individually and use both dust and
5515 // non-dust HTLCs.
5516 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5517 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5518 // tested for at least one of the cases in other tests.
5519 #[test]
5520 fn htlc_claim_single_commitment_only_a() {
5521         do_htlc_claim_local_commitment_only(true);
5522         do_htlc_claim_local_commitment_only(false);
5523
5524         do_htlc_claim_current_remote_commitment_only(true);
5525         do_htlc_claim_current_remote_commitment_only(false);
5526 }
5527
5528 #[test]
5529 fn htlc_claim_single_commitment_only_b() {
5530         do_htlc_claim_previous_remote_commitment_only(true, false);
5531         do_htlc_claim_previous_remote_commitment_only(false, false);
5532         do_htlc_claim_previous_remote_commitment_only(true, true);
5533         do_htlc_claim_previous_remote_commitment_only(false, true);
5534 }
5535
5536 #[test]
5537 #[should_panic]
5538 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5539         let chanmon_cfgs = create_chanmon_cfgs(2);
5540         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5541         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5542         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5543         // Force duplicate randomness for every get-random call
5544         for node in nodes.iter() {
5545                 *node.keys_manager.override_random_bytes.lock().unwrap() = Some([0; 32]);
5546         }
5547
5548         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5549         let channel_value_satoshis=10000;
5550         let push_msat=10001;
5551         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5552         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5553         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &node0_to_1_send_open_channel);
5554         get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
5555
5556         // Create a second channel with the same random values. This used to panic due to a colliding
5557         // channel_id, but now panics due to a colliding outbound SCID alias.
5558         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5559 }
5560
5561 #[test]
5562 fn bolt2_open_channel_sending_node_checks_part2() {
5563         let chanmon_cfgs = create_chanmon_cfgs(2);
5564         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5565         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5566         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5567
5568         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5569         let channel_value_satoshis=2^24;
5570         let push_msat=10001;
5571         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5572
5573         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5574         let channel_value_satoshis=10000;
5575         // Test when push_msat is equal to 1000 * funding_satoshis.
5576         let push_msat=1000*channel_value_satoshis+1;
5577         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5578
5579         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5580         let channel_value_satoshis=10000;
5581         let push_msat=10001;
5582         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
5583         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5584         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5585
5586         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5587         // 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
5588         assert!(node0_to_1_send_open_channel.channel_flags<=1);
5589
5590         // 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.
5591         assert!(BREAKDOWN_TIMEOUT>0);
5592         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5593
5594         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5595         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
5596         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5597
5598         // 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.
5599         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5600         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5601         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5602         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
5603         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5604 }
5605
5606 #[test]
5607 fn bolt2_open_channel_sane_dust_limit() {
5608         let chanmon_cfgs = create_chanmon_cfgs(2);
5609         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5610         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5611         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5612
5613         let channel_value_satoshis=1000000;
5614         let push_msat=10001;
5615         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5616         let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5617         node0_to_1_send_open_channel.dust_limit_satoshis = 547;
5618         node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
5619
5620         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &node0_to_1_send_open_channel);
5621         let events = nodes[1].node.get_and_clear_pending_msg_events();
5622         let err_msg = match events[0] {
5623                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
5624                         msg.clone()
5625                 },
5626                 _ => panic!("Unexpected event"),
5627         };
5628         assert_eq!(err_msg.data, "dust_limit_satoshis (547) is greater than the implementation limit (546)");
5629 }
5630
5631 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
5632 // originated from our node, its failure is surfaced to the user. We trigger this failure to
5633 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
5634 // is no longer affordable once it's freed.
5635 #[test]
5636 fn test_fail_holding_cell_htlc_upon_free() {
5637         let chanmon_cfgs = create_chanmon_cfgs(2);
5638         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5639         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5640         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5641         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
5642
5643         // First nodes[0] generates an update_fee, setting the channel's
5644         // pending_update_fee.
5645         {
5646                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
5647                 *feerate_lock += 20;
5648         }
5649         nodes[0].node.timer_tick_occurred();
5650         check_added_monitors!(nodes[0], 1);
5651
5652         let events = nodes[0].node.get_and_clear_pending_msg_events();
5653         assert_eq!(events.len(), 1);
5654         let (update_msg, commitment_signed) = match events[0] {
5655                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5656                         (update_fee.as_ref(), commitment_signed)
5657                 },
5658                 _ => panic!("Unexpected event"),
5659         };
5660
5661         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5662
5663         let mut chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
5664         let channel_reserve = chan_stat.channel_reserve_msat;
5665         let feerate = get_feerate!(nodes[0], nodes[1], chan.2);
5666         let opt_anchors = get_opt_anchors!(nodes[0], nodes[1], chan.2);
5667
5668         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
5669         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1, opt_anchors);
5670         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], max_can_send);
5671
5672         // Send a payment which passes reserve checks but gets stuck in the holding cell.
5673         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
5674         chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
5675         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
5676
5677         // Flush the pending fee update.
5678         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
5679         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5680         check_added_monitors!(nodes[1], 1);
5681         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
5682         check_added_monitors!(nodes[0], 1);
5683
5684         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
5685         // HTLC, but now that the fee has been raised the payment will now fail, causing
5686         // us to surface its failure to the user.
5687         chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
5688         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
5689         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);
5690         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 {}",
5691                 hex::encode(our_payment_hash.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
5692         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
5693
5694         // Check that the payment failed to be sent out.
5695         let events = nodes[0].node.get_and_clear_pending_events();
5696         assert_eq!(events.len(), 2);
5697         match &events[0] {
5698                 &Event::PaymentPathFailed { ref payment_id, ref payment_hash, ref payment_failed_permanently, ref network_update, ref short_channel_id, .. } => {
5699                         assert_eq!(PaymentId(our_payment_hash.0), *payment_id.as_ref().unwrap());
5700                         assert_eq!(our_payment_hash.clone(), *payment_hash);
5701                         assert_eq!(*payment_failed_permanently, false);
5702                         assert_eq!(*network_update, None);
5703                         assert_eq!(*short_channel_id, Some(route.paths[0][0].short_channel_id));
5704                 },
5705                 _ => panic!("Unexpected event"),
5706         }
5707         match &events[1] {
5708                 &Event::PaymentFailed { ref payment_hash, .. } => {
5709                         assert_eq!(our_payment_hash.clone(), *payment_hash);
5710                 },
5711                 _ => panic!("Unexpected event"),
5712         }
5713 }
5714
5715 // Test that if multiple HTLCs are released from the holding cell and one is
5716 // valid but the other is no longer valid upon release, the valid HTLC can be
5717 // successfully completed while the other one fails as expected.
5718 #[test]
5719 fn test_free_and_fail_holding_cell_htlcs() {
5720         let chanmon_cfgs = create_chanmon_cfgs(2);
5721         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5722         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5723         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5724         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
5725
5726         // First nodes[0] generates an update_fee, setting the channel's
5727         // pending_update_fee.
5728         {
5729                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
5730                 *feerate_lock += 200;
5731         }
5732         nodes[0].node.timer_tick_occurred();
5733         check_added_monitors!(nodes[0], 1);
5734
5735         let events = nodes[0].node.get_and_clear_pending_msg_events();
5736         assert_eq!(events.len(), 1);
5737         let (update_msg, commitment_signed) = match events[0] {
5738                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5739                         (update_fee.as_ref(), commitment_signed)
5740                 },
5741                 _ => panic!("Unexpected event"),
5742         };
5743
5744         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5745
5746         let mut chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
5747         let channel_reserve = chan_stat.channel_reserve_msat;
5748         let feerate = get_feerate!(nodes[0], nodes[1], chan.2);
5749         let opt_anchors = get_opt_anchors!(nodes[0], nodes[1], chan.2);
5750
5751         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
5752         let amt_1 = 20000;
5753         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1, opt_anchors) - amt_1;
5754         let (route_1, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], amt_1);
5755         let (route_2, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], amt_2);
5756
5757         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
5758         nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
5759         chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
5760         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
5761         let payment_id_2 = PaymentId(nodes[0].keys_manager.get_secure_random_bytes());
5762         nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2), payment_id_2).unwrap();
5763         chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
5764         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
5765
5766         // Flush the pending fee update.
5767         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
5768         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5769         check_added_monitors!(nodes[1], 1);
5770         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
5771         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
5772         check_added_monitors!(nodes[0], 2);
5773
5774         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
5775         // but now that the fee has been raised the second payment will now fail, causing us
5776         // to surface its failure to the user. The first payment should succeed.
5777         chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
5778         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
5779         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);
5780         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 {}",
5781                 hex::encode(payment_hash_2.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
5782         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
5783
5784         // Check that the second payment failed to be sent out.
5785         let events = nodes[0].node.get_and_clear_pending_events();
5786         assert_eq!(events.len(), 2);
5787         match &events[0] {
5788                 &Event::PaymentPathFailed { ref payment_id, ref payment_hash, ref payment_failed_permanently, ref network_update, ref short_channel_id, .. } => {
5789                         assert_eq!(payment_id_2, *payment_id.as_ref().unwrap());
5790                         assert_eq!(payment_hash_2.clone(), *payment_hash);
5791                         assert_eq!(*payment_failed_permanently, false);
5792                         assert_eq!(*network_update, None);
5793                         assert_eq!(*short_channel_id, Some(route_2.paths[0][0].short_channel_id));
5794                 },
5795                 _ => panic!("Unexpected event"),
5796         }
5797         match &events[1] {
5798                 &Event::PaymentFailed { ref payment_hash, .. } => {
5799                         assert_eq!(payment_hash_2.clone(), *payment_hash);
5800                 },
5801                 _ => panic!("Unexpected event"),
5802         }
5803
5804         // Complete the first payment and the RAA from the fee update.
5805         let (payment_event, send_raa_event) = {
5806                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
5807                 assert_eq!(msgs.len(), 2);
5808                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
5809         };
5810         let raa = match send_raa_event {
5811                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
5812                 _ => panic!("Unexpected event"),
5813         };
5814         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
5815         check_added_monitors!(nodes[1], 1);
5816         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5817         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5818         let events = nodes[1].node.get_and_clear_pending_events();
5819         assert_eq!(events.len(), 1);
5820         match events[0] {
5821                 Event::PendingHTLCsForwardable { .. } => {},
5822                 _ => panic!("Unexpected event"),
5823         }
5824         nodes[1].node.process_pending_htlc_forwards();
5825         let events = nodes[1].node.get_and_clear_pending_events();
5826         assert_eq!(events.len(), 1);
5827         match events[0] {
5828                 Event::PaymentClaimable { .. } => {},
5829                 _ => panic!("Unexpected event"),
5830         }
5831         nodes[1].node.claim_funds(payment_preimage_1);
5832         check_added_monitors!(nodes[1], 1);
5833         expect_payment_claimed!(nodes[1], payment_hash_1, amt_1);
5834
5835         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5836         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
5837         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
5838         expect_payment_sent!(nodes[0], payment_preimage_1);
5839 }
5840
5841 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
5842 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
5843 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
5844 // once it's freed.
5845 #[test]
5846 fn test_fail_holding_cell_htlc_upon_free_multihop() {
5847         let chanmon_cfgs = create_chanmon_cfgs(3);
5848         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5849         // When this test was written, the default base fee floated based on the HTLC count.
5850         // It is now fixed, so we simply set the fee to the expected value here.
5851         let mut config = test_default_channel_config();
5852         config.channel_config.forwarding_fee_base_msat = 196;
5853         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5854         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5855         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
5856         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000);
5857
5858         // First nodes[1] generates an update_fee, setting the channel's
5859         // pending_update_fee.
5860         {
5861                 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
5862                 *feerate_lock += 20;
5863         }
5864         nodes[1].node.timer_tick_occurred();
5865         check_added_monitors!(nodes[1], 1);
5866
5867         let events = nodes[1].node.get_and_clear_pending_msg_events();
5868         assert_eq!(events.len(), 1);
5869         let (update_msg, commitment_signed) = match events[0] {
5870                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5871                         (update_fee.as_ref(), commitment_signed)
5872                 },
5873                 _ => panic!("Unexpected event"),
5874         };
5875
5876         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
5877
5878         let mut chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan_0_1.2);
5879         let channel_reserve = chan_stat.channel_reserve_msat;
5880         let feerate = get_feerate!(nodes[0], nodes[1], chan_0_1.2);
5881         let opt_anchors = get_opt_anchors!(nodes[0], nodes[1], chan_0_1.2);
5882
5883         // Send a payment which passes reserve checks but gets stuck in the holding cell.
5884         let feemsat = 239;
5885         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
5886         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1, opt_anchors) - total_routing_fee_msat;
5887         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], max_can_send);
5888         let payment_event = {
5889                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
5890                 check_added_monitors!(nodes[0], 1);
5891
5892                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5893                 assert_eq!(events.len(), 1);
5894
5895                 SendEvent::from_event(events.remove(0))
5896         };
5897         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5898         check_added_monitors!(nodes[1], 0);
5899         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5900         expect_pending_htlcs_forwardable!(nodes[1]);
5901
5902         chan_stat = get_channel_value_stat!(nodes[1], nodes[2], chan_1_2.2);
5903         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
5904
5905         // Flush the pending fee update.
5906         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
5907         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5908         check_added_monitors!(nodes[2], 1);
5909         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
5910         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
5911         check_added_monitors!(nodes[1], 2);
5912
5913         // A final RAA message is generated to finalize the fee update.
5914         let events = nodes[1].node.get_and_clear_pending_msg_events();
5915         assert_eq!(events.len(), 1);
5916
5917         let raa_msg = match &events[0] {
5918                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
5919                         msg.clone()
5920                 },
5921                 _ => panic!("Unexpected event"),
5922         };
5923
5924         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
5925         check_added_monitors!(nodes[2], 1);
5926         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
5927
5928         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
5929         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
5930         assert_eq!(process_htlc_forwards_event.len(), 2);
5931         match &process_htlc_forwards_event[0] {
5932                 &Event::PendingHTLCsForwardable { .. } => {},
5933                 _ => panic!("Unexpected event"),
5934         }
5935
5936         // In response, we call ChannelManager's process_pending_htlc_forwards
5937         nodes[1].node.process_pending_htlc_forwards();
5938         check_added_monitors!(nodes[1], 1);
5939
5940         // This causes the HTLC to be failed backwards.
5941         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
5942         assert_eq!(fail_event.len(), 1);
5943         let (fail_msg, commitment_signed) = match &fail_event[0] {
5944                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
5945                         assert_eq!(updates.update_add_htlcs.len(), 0);
5946                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
5947                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
5948                         assert_eq!(updates.update_fail_htlcs.len(), 1);
5949                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
5950                 },
5951                 _ => panic!("Unexpected event"),
5952         };
5953
5954         // Pass the failure messages back to nodes[0].
5955         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
5956         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
5957
5958         // Complete the HTLC failure+removal process.
5959         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5960         check_added_monitors!(nodes[0], 1);
5961         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
5962         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
5963         check_added_monitors!(nodes[1], 2);
5964         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
5965         assert_eq!(final_raa_event.len(), 1);
5966         let raa = match &final_raa_event[0] {
5967                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
5968                 _ => panic!("Unexpected event"),
5969         };
5970         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
5971         expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_1_2.0.contents.short_channel_id, false);
5972         check_added_monitors!(nodes[0], 1);
5973 }
5974
5975 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
5976 // 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.
5977 //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.
5978
5979 #[test]
5980 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
5981         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
5982         let chanmon_cfgs = create_chanmon_cfgs(2);
5983         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5984         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5985         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5986         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
5987
5988         let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
5989         route.paths[0][0].fee_msat = 100;
5990
5991         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
5992                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
5993         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5994         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
5995 }
5996
5997 #[test]
5998 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
5999         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6000         let chanmon_cfgs = create_chanmon_cfgs(2);
6001         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6002         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6003         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6004         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
6005
6006         let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
6007         route.paths[0][0].fee_msat = 0;
6008         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
6009                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6010
6011         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6012         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6013 }
6014
6015 #[test]
6016 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6017         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6018         let chanmon_cfgs = create_chanmon_cfgs(2);
6019         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6020         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6021         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6022         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
6023
6024         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
6025         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6026         check_added_monitors!(nodes[0], 1);
6027         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6028         updates.update_add_htlcs[0].amount_msat = 0;
6029
6030         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6031         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6032         check_closed_broadcast!(nodes[1], true).unwrap();
6033         check_added_monitors!(nodes[1], 1);
6034         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Remote side tried to send a 0-msat HTLC".to_string() });
6035 }
6036
6037 #[test]
6038 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6039         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6040         //It is enforced when constructing a route.
6041         let chanmon_cfgs = create_chanmon_cfgs(2);
6042         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6043         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6044         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6045         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0);
6046
6047         let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), 0)
6048                 .with_features(nodes[1].node.invoice_features());
6049         let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], payment_params, 100000000, 0);
6050         route.paths[0].last_mut().unwrap().cltv_expiry_delta = 500000001;
6051         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::InvalidRoute { ref err },
6052                 assert_eq!(err, &"Channel CLTV overflowed?"));
6053 }
6054
6055 #[test]
6056 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6057         //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.
6058         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6059         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6060         let chanmon_cfgs = create_chanmon_cfgs(2);
6061         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6062         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6063         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6064         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0);
6065         let max_accepted_htlcs = nodes[1].node.per_peer_state.read().unwrap().get(&nodes[0].node.get_our_node_id())
6066                 .unwrap().lock().unwrap().channel_by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6067
6068         for i in 0..max_accepted_htlcs {
6069                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
6070                 let payment_event = {
6071                         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6072                         check_added_monitors!(nodes[0], 1);
6073
6074                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6075                         assert_eq!(events.len(), 1);
6076                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6077                                 assert_eq!(htlcs[0].htlc_id, i);
6078                         } else {
6079                                 assert!(false);
6080                         }
6081                         SendEvent::from_event(events.remove(0))
6082                 };
6083                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6084                 check_added_monitors!(nodes[1], 0);
6085                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6086
6087                 expect_pending_htlcs_forwardable!(nodes[1]);
6088                 expect_payment_claimable!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6089         }
6090         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
6091         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
6092                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6093
6094         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6095         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6096 }
6097
6098 #[test]
6099 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6100         //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.
6101         let chanmon_cfgs = create_chanmon_cfgs(2);
6102         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6103         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6104         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6105         let channel_value = 100000;
6106         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0);
6107         let max_in_flight = get_channel_value_stat!(nodes[0], nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat;
6108
6109         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6110
6111         let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], max_in_flight);
6112         // Manually create a route over our max in flight (which our router normally automatically
6113         // limits us to.
6114         route.paths[0][0].fee_msat =  max_in_flight + 1;
6115         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
6116                 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)));
6117
6118         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6119         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);
6120
6121         send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6122 }
6123
6124 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6125 #[test]
6126 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6127         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6128         let chanmon_cfgs = create_chanmon_cfgs(2);
6129         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6130         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6131         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6132         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
6133         let htlc_minimum_msat: u64;
6134         {
6135                 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
6136                 let chan_lock = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
6137                 let channel = chan_lock.channel_by_id.get(&chan.2).unwrap();
6138                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6139         }
6140
6141         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], htlc_minimum_msat);
6142         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6143         check_added_monitors!(nodes[0], 1);
6144         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6145         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6146         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6147         assert!(nodes[1].node.list_channels().is_empty());
6148         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6149         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()));
6150         check_added_monitors!(nodes[1], 1);
6151         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6152 }
6153
6154 #[test]
6155 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6156         //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
6157         let chanmon_cfgs = create_chanmon_cfgs(2);
6158         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6159         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6160         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6161         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
6162
6163         let chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
6164         let channel_reserve = chan_stat.channel_reserve_msat;
6165         let feerate = get_feerate!(nodes[0], nodes[1], chan.2);
6166         let opt_anchors = get_opt_anchors!(nodes[0], nodes[1], chan.2);
6167         // The 2* and +1 are for the fee spike reserve.
6168         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1, opt_anchors);
6169
6170         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6171         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], max_can_send);
6172         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6173         check_added_monitors!(nodes[0], 1);
6174         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6175
6176         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6177         // at this time channel-initiatee receivers are not required to enforce that senders
6178         // respect the fee_spike_reserve.
6179         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6180         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6181
6182         assert!(nodes[1].node.list_channels().is_empty());
6183         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6184         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6185         check_added_monitors!(nodes[1], 1);
6186         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6187 }
6188
6189 #[test]
6190 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6191         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6192         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6193         let chanmon_cfgs = create_chanmon_cfgs(2);
6194         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6195         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6196         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6197         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
6198
6199         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3999999);
6200         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6201         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6202         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6203         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height, &None).unwrap();
6204         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6205
6206         let mut msg = msgs::UpdateAddHTLC {
6207                 channel_id: chan.2,
6208                 htlc_id: 0,
6209                 amount_msat: 1000,
6210                 payment_hash: our_payment_hash,
6211                 cltv_expiry: htlc_cltv,
6212                 onion_routing_packet: onion_packet.clone(),
6213         };
6214
6215         for i in 0..super::channel::OUR_MAX_HTLCS {
6216                 msg.htlc_id = i as u64;
6217                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6218         }
6219         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6220         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6221
6222         assert!(nodes[1].node.list_channels().is_empty());
6223         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6224         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6225         check_added_monitors!(nodes[1], 1);
6226         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6227 }
6228
6229 #[test]
6230 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6231         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6232         let chanmon_cfgs = create_chanmon_cfgs(2);
6233         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6234         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6235         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6236         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
6237
6238         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6239         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6240         check_added_monitors!(nodes[0], 1);
6241         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6242         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6243         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6244
6245         assert!(nodes[1].node.list_channels().is_empty());
6246         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6247         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6248         check_added_monitors!(nodes[1], 1);
6249         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6250 }
6251
6252 #[test]
6253 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6254         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6255         let chanmon_cfgs = create_chanmon_cfgs(2);
6256         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6257         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6258         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6259
6260         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
6261         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6262         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6263         check_added_monitors!(nodes[0], 1);
6264         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6265         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6266         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6267
6268         assert!(nodes[1].node.list_channels().is_empty());
6269         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6270         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6271         check_added_monitors!(nodes[1], 1);
6272         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6273 }
6274
6275 #[test]
6276 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6277         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6278         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6279         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6280         let chanmon_cfgs = create_chanmon_cfgs(2);
6281         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6282         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6283         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6284
6285         create_announced_chan_between_nodes(&nodes, 0, 1);
6286         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6287         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6288         check_added_monitors!(nodes[0], 1);
6289         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6290         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6291
6292         //Disconnect and Reconnect
6293         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
6294         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
6295         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }, true).unwrap();
6296         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6297         assert_eq!(reestablish_1.len(), 1);
6298         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }, false).unwrap();
6299         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6300         assert_eq!(reestablish_2.len(), 1);
6301         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6302         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6303         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6304         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6305
6306         //Resend HTLC
6307         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6308         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6309         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6310         check_added_monitors!(nodes[1], 1);
6311         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6312
6313         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6314
6315         assert!(nodes[1].node.list_channels().is_empty());
6316         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6317         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6318         check_added_monitors!(nodes[1], 1);
6319         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6320 }
6321
6322 #[test]
6323 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6324         //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.
6325
6326         let chanmon_cfgs = create_chanmon_cfgs(2);
6327         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6328         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6329         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6330         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
6331         let (route, our_payment_hash, our_payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6332         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6333
6334         check_added_monitors!(nodes[0], 1);
6335         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6336         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6337
6338         let update_msg = msgs::UpdateFulfillHTLC{
6339                 channel_id: chan.2,
6340                 htlc_id: 0,
6341                 payment_preimage: our_payment_preimage,
6342         };
6343
6344         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6345
6346         assert!(nodes[0].node.list_channels().is_empty());
6347         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6348         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()));
6349         check_added_monitors!(nodes[0], 1);
6350         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6351 }
6352
6353 #[test]
6354 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6355         //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.
6356
6357         let chanmon_cfgs = create_chanmon_cfgs(2);
6358         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6359         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6360         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6361         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
6362
6363         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6364         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6365         check_added_monitors!(nodes[0], 1);
6366         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6367         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6368
6369         let update_msg = msgs::UpdateFailHTLC{
6370                 channel_id: chan.2,
6371                 htlc_id: 0,
6372                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6373         };
6374
6375         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6376
6377         assert!(nodes[0].node.list_channels().is_empty());
6378         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6379         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()));
6380         check_added_monitors!(nodes[0], 1);
6381         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6382 }
6383
6384 #[test]
6385 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6386         //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.
6387
6388         let chanmon_cfgs = create_chanmon_cfgs(2);
6389         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6390         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6391         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6392         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
6393
6394         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6395         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6396         check_added_monitors!(nodes[0], 1);
6397         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6398         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6399         let update_msg = msgs::UpdateFailMalformedHTLC{
6400                 channel_id: chan.2,
6401                 htlc_id: 0,
6402                 sha256_of_onion: [1; 32],
6403                 failure_code: 0x8000,
6404         };
6405
6406         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6407
6408         assert!(nodes[0].node.list_channels().is_empty());
6409         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6410         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()));
6411         check_added_monitors!(nodes[0], 1);
6412         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6413 }
6414
6415 #[test]
6416 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6417         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6418
6419         let chanmon_cfgs = create_chanmon_cfgs(2);
6420         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6421         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6422         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6423         create_announced_chan_between_nodes(&nodes, 0, 1);
6424
6425         let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 100_000);
6426
6427         nodes[1].node.claim_funds(our_payment_preimage);
6428         check_added_monitors!(nodes[1], 1);
6429         expect_payment_claimed!(nodes[1], our_payment_hash, 100_000);
6430
6431         let events = nodes[1].node.get_and_clear_pending_msg_events();
6432         assert_eq!(events.len(), 1);
6433         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6434                 match events[0] {
6435                         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, .. } } => {
6436                                 assert!(update_add_htlcs.is_empty());
6437                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6438                                 assert!(update_fail_htlcs.is_empty());
6439                                 assert!(update_fail_malformed_htlcs.is_empty());
6440                                 assert!(update_fee.is_none());
6441                                 update_fulfill_htlcs[0].clone()
6442                         },
6443                         _ => panic!("Unexpected event"),
6444                 }
6445         };
6446
6447         update_fulfill_msg.htlc_id = 1;
6448
6449         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6450
6451         assert!(nodes[0].node.list_channels().is_empty());
6452         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6453         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6454         check_added_monitors!(nodes[0], 1);
6455         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6456 }
6457
6458 #[test]
6459 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6460         //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.
6461
6462         let chanmon_cfgs = create_chanmon_cfgs(2);
6463         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6464         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6465         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6466         create_announced_chan_between_nodes(&nodes, 0, 1);
6467
6468         let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 100_000);
6469
6470         nodes[1].node.claim_funds(our_payment_preimage);
6471         check_added_monitors!(nodes[1], 1);
6472         expect_payment_claimed!(nodes[1], our_payment_hash, 100_000);
6473
6474         let events = nodes[1].node.get_and_clear_pending_msg_events();
6475         assert_eq!(events.len(), 1);
6476         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6477                 match events[0] {
6478                         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, .. } } => {
6479                                 assert!(update_add_htlcs.is_empty());
6480                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6481                                 assert!(update_fail_htlcs.is_empty());
6482                                 assert!(update_fail_malformed_htlcs.is_empty());
6483                                 assert!(update_fee.is_none());
6484                                 update_fulfill_htlcs[0].clone()
6485                         },
6486                         _ => panic!("Unexpected event"),
6487                 }
6488         };
6489
6490         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6491
6492         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6493
6494         assert!(nodes[0].node.list_channels().is_empty());
6495         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6496         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6497         check_added_monitors!(nodes[0], 1);
6498         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6499 }
6500
6501 #[test]
6502 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6503         //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.
6504
6505         let chanmon_cfgs = create_chanmon_cfgs(2);
6506         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6507         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6508         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6509         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
6510
6511         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6512         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6513         check_added_monitors!(nodes[0], 1);
6514
6515         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6516         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6517
6518         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6519         check_added_monitors!(nodes[1], 0);
6520         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6521
6522         let events = nodes[1].node.get_and_clear_pending_msg_events();
6523
6524         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6525                 match events[0] {
6526                         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, .. } } => {
6527                                 assert!(update_add_htlcs.is_empty());
6528                                 assert!(update_fulfill_htlcs.is_empty());
6529                                 assert!(update_fail_htlcs.is_empty());
6530                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6531                                 assert!(update_fee.is_none());
6532                                 update_fail_malformed_htlcs[0].clone()
6533                         },
6534                         _ => panic!("Unexpected event"),
6535                 }
6536         };
6537         update_msg.failure_code &= !0x8000;
6538         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6539
6540         assert!(nodes[0].node.list_channels().is_empty());
6541         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6542         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6543         check_added_monitors!(nodes[0], 1);
6544         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6545 }
6546
6547 #[test]
6548 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6549         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6550         //    * 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.
6551
6552         let chanmon_cfgs = create_chanmon_cfgs(3);
6553         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6554         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6555         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6556         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
6557         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000);
6558
6559         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100000);
6560
6561         //First hop
6562         let mut payment_event = {
6563                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6564                 check_added_monitors!(nodes[0], 1);
6565                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6566                 assert_eq!(events.len(), 1);
6567                 SendEvent::from_event(events.remove(0))
6568         };
6569         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6570         check_added_monitors!(nodes[1], 0);
6571         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6572         expect_pending_htlcs_forwardable!(nodes[1]);
6573         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6574         assert_eq!(events_2.len(), 1);
6575         check_added_monitors!(nodes[1], 1);
6576         payment_event = SendEvent::from_event(events_2.remove(0));
6577         assert_eq!(payment_event.msgs.len(), 1);
6578
6579         //Second Hop
6580         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6581         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6582         check_added_monitors!(nodes[2], 0);
6583         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6584
6585         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6586         assert_eq!(events_3.len(), 1);
6587         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6588                 match events_3[0] {
6589                         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 } } => {
6590                                 assert!(update_add_htlcs.is_empty());
6591                                 assert!(update_fulfill_htlcs.is_empty());
6592                                 assert!(update_fail_htlcs.is_empty());
6593                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6594                                 assert!(update_fee.is_none());
6595                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6596                         },
6597                         _ => panic!("Unexpected event"),
6598                 }
6599         };
6600
6601         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6602
6603         check_added_monitors!(nodes[1], 0);
6604         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6605         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
6606         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6607         assert_eq!(events_4.len(), 1);
6608
6609         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6610         match events_4[0] {
6611                 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, .. } } => {
6612                         assert!(update_add_htlcs.is_empty());
6613                         assert!(update_fulfill_htlcs.is_empty());
6614                         assert_eq!(update_fail_htlcs.len(), 1);
6615                         assert!(update_fail_malformed_htlcs.is_empty());
6616                         assert!(update_fee.is_none());
6617                 },
6618                 _ => panic!("Unexpected event"),
6619         };
6620
6621         check_added_monitors!(nodes[1], 1);
6622 }
6623
6624 #[test]
6625 fn test_channel_failed_after_message_with_badonion_node_perm_bits_set() {
6626         let chanmon_cfgs = create_chanmon_cfgs(3);
6627         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6628         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6629         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6630         create_announced_chan_between_nodes(&nodes, 0, 1);
6631         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
6632
6633         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100_000);
6634
6635         // First hop
6636         let mut payment_event = {
6637                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6638                 check_added_monitors!(nodes[0], 1);
6639                 SendEvent::from_node(&nodes[0])
6640         };
6641
6642         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6643         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6644         expect_pending_htlcs_forwardable!(nodes[1]);
6645         check_added_monitors!(nodes[1], 1);
6646         payment_event = SendEvent::from_node(&nodes[1]);
6647         assert_eq!(payment_event.msgs.len(), 1);
6648
6649         // Second Hop
6650         payment_event.msgs[0].onion_routing_packet.version = 1; // Trigger an invalid_onion_version error
6651         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6652         check_added_monitors!(nodes[2], 0);
6653         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6654
6655         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6656         assert_eq!(events_3.len(), 1);
6657         match events_3[0] {
6658                 MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6659                         let mut update_msg = updates.update_fail_malformed_htlcs[0].clone();
6660                         // Set the NODE bit (BADONION and PERM already set in invalid_onion_version error)
6661                         update_msg.failure_code |= 0x2000;
6662
6663                         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg);
6664                         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true);
6665                 },
6666                 _ => panic!("Unexpected event"),
6667         }
6668
6669         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1],
6670                 vec![HTLCDestination::NextHopChannel {
6671                         node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
6672         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6673         assert_eq!(events_4.len(), 1);
6674         check_added_monitors!(nodes[1], 1);
6675
6676         match events_4[0] {
6677                 MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6678                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
6679                         commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false, true);
6680                 },
6681                 _ => panic!("Unexpected event"),
6682         }
6683
6684         let events_5 = nodes[0].node.get_and_clear_pending_events();
6685         assert_eq!(events_5.len(), 2);
6686
6687         // Expect a PaymentPathFailed event with a ChannelFailure network update for the channel between
6688         // the node originating the error to its next hop.
6689         match events_5[0] {
6690                 Event::PaymentPathFailed { network_update:
6691                         Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent }), error_code, ..
6692                 } => {
6693                         assert_eq!(short_channel_id, chan_2.0.contents.short_channel_id);
6694                         assert!(is_permanent);
6695                         assert_eq!(error_code, Some(0x8000|0x4000|0x2000|4));
6696                 },
6697                 _ => panic!("Unexpected event"),
6698         }
6699         match events_5[1] {
6700                 Event::PaymentFailed { payment_hash, .. } => {
6701                         assert_eq!(payment_hash, our_payment_hash);
6702                 },
6703                 _ => panic!("Unexpected event"),
6704         }
6705
6706         // TODO: Test actual removal of channel from NetworkGraph when it's implemented.
6707 }
6708
6709 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6710         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6711         // 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
6712         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6713
6714         let mut chanmon_cfgs = create_chanmon_cfgs(2);
6715         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
6716         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6717         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6718         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6719         let chan =create_announced_chan_between_nodes(&nodes, 0, 1);
6720
6721         let bs_dust_limit = nodes[1].node.per_peer_state.read().unwrap().get(&nodes[0].node.get_our_node_id())
6722                 .unwrap().lock().unwrap().channel_by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
6723
6724         // We route 2 dust-HTLCs between A and B
6725         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6726         let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6727         route_payment(&nodes[0], &[&nodes[1]], 1000000);
6728
6729         // Cache one local commitment tx as previous
6730         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6731
6732         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6733         nodes[1].node.fail_htlc_backwards(&payment_hash_2);
6734         check_added_monitors!(nodes[1], 0);
6735         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_2 }]);
6736         check_added_monitors!(nodes[1], 1);
6737
6738         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6739         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
6740         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
6741         check_added_monitors!(nodes[0], 1);
6742
6743         // Cache one local commitment tx as lastest
6744         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6745
6746         let events = nodes[0].node.get_and_clear_pending_msg_events();
6747         match events[0] {
6748                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
6749                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6750                 },
6751                 _ => panic!("Unexpected event"),
6752         }
6753         match events[1] {
6754                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
6755                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6756                 },
6757                 _ => panic!("Unexpected event"),
6758         }
6759
6760         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
6761         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
6762         if announce_latest {
6763                 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
6764         } else {
6765                 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
6766         }
6767
6768         check_closed_broadcast!(nodes[0], true);
6769         check_added_monitors!(nodes[0], 1);
6770         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
6771
6772         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6773         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
6774         let events = nodes[0].node.get_and_clear_pending_events();
6775         // Only 2 PaymentPathFailed events should show up, over-dust HTLC has to be failed by timeout tx
6776         assert_eq!(events.len(), 4);
6777         let mut first_failed = false;
6778         for event in events {
6779                 match event {
6780                         Event::PaymentPathFailed { payment_hash, .. } => {
6781                                 if payment_hash == payment_hash_1 {
6782                                         assert!(!first_failed);
6783                                         first_failed = true;
6784                                 } else {
6785                                         assert_eq!(payment_hash, payment_hash_2);
6786                                 }
6787                         },
6788                         Event::PaymentFailed { .. } => {}
6789                         _ => panic!("Unexpected event"),
6790                 }
6791         }
6792 }
6793
6794 #[test]
6795 fn test_failure_delay_dust_htlc_local_commitment() {
6796         do_test_failure_delay_dust_htlc_local_commitment(true);
6797         do_test_failure_delay_dust_htlc_local_commitment(false);
6798 }
6799
6800 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
6801         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
6802         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
6803         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
6804         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
6805         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
6806         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
6807
6808         let chanmon_cfgs = create_chanmon_cfgs(3);
6809         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6810         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6811         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6812         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
6813
6814         let bs_dust_limit = nodes[1].node.per_peer_state.read().unwrap().get(&nodes[0].node.get_our_node_id())
6815                 .unwrap().lock().unwrap().channel_by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
6816
6817         let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6818         let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6819
6820         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6821         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
6822
6823         // We revoked bs_commitment_tx
6824         if revoked {
6825                 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6826                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
6827         }
6828
6829         let mut timeout_tx = Vec::new();
6830         if local {
6831                 // We fail dust-HTLC 1 by broadcast of local commitment tx
6832                 mine_transaction(&nodes[0], &as_commitment_tx[0]);
6833                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
6834                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
6835                 expect_payment_failed!(nodes[0], dust_hash, false);
6836
6837                 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
6838                 check_closed_broadcast!(nodes[0], true);
6839                 check_added_monitors!(nodes[0], 1);
6840                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6841                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6842                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6843                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
6844                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6845                 mine_transaction(&nodes[0], &timeout_tx[0]);
6846                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
6847                 expect_payment_failed!(nodes[0], non_dust_hash, false);
6848         } else {
6849                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
6850                 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
6851                 check_closed_broadcast!(nodes[0], true);
6852                 check_added_monitors!(nodes[0], 1);
6853                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
6854                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6855
6856                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
6857                 timeout_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().drain(..)
6858                         .filter(|tx| tx.input[0].previous_output.txid == bs_commitment_tx[0].txid()).collect();
6859                 check_spends!(timeout_tx[0], bs_commitment_tx[0]);
6860                 // For both a revoked or non-revoked commitment transaction, after ANTI_REORG_DELAY the
6861                 // dust HTLC should have been failed.
6862                 expect_payment_failed!(nodes[0], dust_hash, false);
6863
6864                 if !revoked {
6865                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
6866                 } else {
6867                         assert_eq!(timeout_tx[0].lock_time.0, 0);
6868                 }
6869                 // We fail non-dust-HTLC 2 by broadcast of local timeout/revocation-claim tx
6870                 mine_transaction(&nodes[0], &timeout_tx[0]);
6871                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6872                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
6873                 expect_payment_failed!(nodes[0], non_dust_hash, false);
6874         }
6875 }
6876
6877 #[test]
6878 fn test_sweep_outbound_htlc_failure_update() {
6879         do_test_sweep_outbound_htlc_failure_update(false, true);
6880         do_test_sweep_outbound_htlc_failure_update(false, false);
6881         do_test_sweep_outbound_htlc_failure_update(true, false);
6882 }
6883
6884 #[test]
6885 fn test_user_configurable_csv_delay() {
6886         // We test our channel constructors yield errors when we pass them absurd csv delay
6887
6888         let mut low_our_to_self_config = UserConfig::default();
6889         low_our_to_self_config.channel_handshake_config.our_to_self_delay = 6;
6890         let mut high_their_to_self_config = UserConfig::default();
6891         high_their_to_self_config.channel_handshake_limits.their_to_self_delay = 100;
6892         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
6893         let chanmon_cfgs = create_chanmon_cfgs(2);
6894         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6895         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
6896         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6897
6898         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
6899         if let Err(error) = Channel::new_outbound(&LowerBoundedFeeEstimator::new(&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }),
6900                 &nodes[0].keys_manager, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), &nodes[1].node.init_features(), 1000000, 1000000, 0,
6901                 &low_our_to_self_config, 0, 42)
6902         {
6903                 match error {
6904                         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())); },
6905                         _ => panic!("Unexpected event"),
6906                 }
6907         } else { assert!(false) }
6908
6909         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
6910         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6911         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6912         open_channel.to_self_delay = 200;
6913         if let Err(error) = Channel::new_from_req(&LowerBoundedFeeEstimator::new(&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }),
6914                 &nodes[0].keys_manager, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), &nodes[0].node.channel_type_features(), &nodes[1].node.init_features(), &open_channel, 0,
6915                 &low_our_to_self_config, 0, &nodes[0].logger, 42)
6916         {
6917                 match error {
6918                         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()));  },
6919                         _ => panic!("Unexpected event"),
6920                 }
6921         } else { assert!(false); }
6922
6923         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
6924         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6925         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
6926         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
6927         accept_channel.to_self_delay = 200;
6928         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
6929         let reason_msg;
6930         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
6931                 match action {
6932                         &ErrorAction::SendErrorMessage { ref msg } => {
6933                                 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()));
6934                                 reason_msg = msg.data.clone();
6935                         },
6936                         _ => { panic!(); }
6937                 }
6938         } else { panic!(); }
6939         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: reason_msg });
6940
6941         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
6942         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6943         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6944         open_channel.to_self_delay = 200;
6945         if let Err(error) = Channel::new_from_req(&LowerBoundedFeeEstimator::new(&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }),
6946                 &nodes[0].keys_manager, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), &nodes[0].node.channel_type_features(), &nodes[1].node.init_features(), &open_channel, 0,
6947                 &high_their_to_self_config, 0, &nodes[0].logger, 42)
6948         {
6949                 match error {
6950                         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())); },
6951                         _ => panic!("Unexpected event"),
6952                 }
6953         } else { assert!(false); }
6954 }
6955
6956 #[test]
6957 fn test_check_htlc_underpaying() {
6958         // Send payment through A -> B but A is maliciously
6959         // sending a probe payment (i.e less than expected value0
6960         // to B, B should refuse payment.
6961
6962         let chanmon_cfgs = create_chanmon_cfgs(2);
6963         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6964         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6965         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6966
6967         // Create some initial channels
6968         create_announced_chan_between_nodes(&nodes, 0, 1);
6969
6970         let scorer = test_utils::TestScorer::new();
6971         let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
6972         let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV).with_features(nodes[1].node.invoice_features());
6973         let route = get_route(&nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph.read_only(), None, 10_000, TEST_FINAL_CLTV, nodes[0].logger, &scorer, &random_seed_bytes).unwrap();
6974         let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
6975         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, None).unwrap();
6976         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6977         check_added_monitors!(nodes[0], 1);
6978
6979         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6980         assert_eq!(events.len(), 1);
6981         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
6982         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6983         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6984
6985         // Note that we first have to wait a random delay before processing the receipt of the HTLC,
6986         // and then will wait a second random delay before failing the HTLC back:
6987         expect_pending_htlcs_forwardable!(nodes[1]);
6988         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
6989
6990         // Node 3 is expecting payment of 100_000 but received 10_000,
6991         // it should fail htlc like we didn't know the preimage.
6992         nodes[1].node.process_pending_htlc_forwards();
6993
6994         let events = nodes[1].node.get_and_clear_pending_msg_events();
6995         assert_eq!(events.len(), 1);
6996         let (update_fail_htlc, commitment_signed) = 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, ref commitment_signed } } => {
6998                         assert!(update_add_htlcs.is_empty());
6999                         assert!(update_fulfill_htlcs.is_empty());
7000                         assert_eq!(update_fail_htlcs.len(), 1);
7001                         assert!(update_fail_malformed_htlcs.is_empty());
7002                         assert!(update_fee.is_none());
7003                         (update_fail_htlcs[0].clone(), commitment_signed)
7004                 },
7005                 _ => panic!("Unexpected event"),
7006         };
7007         check_added_monitors!(nodes[1], 1);
7008
7009         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7010         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7011
7012         // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7013         let mut expected_failure_data = (10_000 as u64).to_be_bytes().to_vec();
7014         expected_failure_data.extend_from_slice(&CHAN_CONFIRM_DEPTH.to_be_bytes());
7015         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7016 }
7017
7018 #[test]
7019 fn test_announce_disable_channels() {
7020         // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7021         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7022
7023         let chanmon_cfgs = create_chanmon_cfgs(2);
7024         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7025         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7026         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7027
7028         create_announced_chan_between_nodes(&nodes, 0, 1);
7029         create_announced_chan_between_nodes(&nodes, 1, 0);
7030         create_announced_chan_between_nodes(&nodes, 0, 1);
7031
7032         // Disconnect peers
7033         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
7034         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
7035
7036         nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7037         nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7038         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7039         assert_eq!(msg_events.len(), 3);
7040         let mut chans_disabled = HashMap::new();
7041         for e in msg_events {
7042                 match e {
7043                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7044                                 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7045                                 // Check that each channel gets updated exactly once
7046                                 if chans_disabled.insert(msg.contents.short_channel_id, msg.contents.timestamp).is_some() {
7047                                         panic!("Generated ChannelUpdate for wrong chan!");
7048                                 }
7049                         },
7050                         _ => panic!("Unexpected event"),
7051                 }
7052         }
7053         // Reconnect peers
7054         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }, true).unwrap();
7055         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7056         assert_eq!(reestablish_1.len(), 3);
7057         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }, false).unwrap();
7058         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7059         assert_eq!(reestablish_2.len(), 3);
7060
7061         // Reestablish chan_1
7062         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7063         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7064         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7065         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7066         // Reestablish chan_2
7067         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7068         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7069         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7070         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7071         // Reestablish chan_3
7072         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7073         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7074         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7075         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7076
7077         nodes[0].node.timer_tick_occurred();
7078         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7079         nodes[0].node.timer_tick_occurred();
7080         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7081         assert_eq!(msg_events.len(), 3);
7082         for e in msg_events {
7083                 match e {
7084                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7085                                 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7086                                 match chans_disabled.remove(&msg.contents.short_channel_id) {
7087                                         // Each update should have a higher timestamp than the previous one, replacing
7088                                         // the old one.
7089                                         Some(prev_timestamp) => assert!(msg.contents.timestamp > prev_timestamp),
7090                                         None => panic!("Generated ChannelUpdate for wrong chan!"),
7091                                 }
7092                         },
7093                         _ => panic!("Unexpected event"),
7094                 }
7095         }
7096         // Check that each channel gets updated exactly once
7097         assert!(chans_disabled.is_empty());
7098 }
7099
7100 #[test]
7101 fn test_bump_penalty_txn_on_revoked_commitment() {
7102         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7103         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7104
7105         let chanmon_cfgs = create_chanmon_cfgs(2);
7106         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7107         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7108         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7109
7110         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000);
7111
7112         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7113         let payment_params = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id(), 30)
7114                 .with_features(nodes[0].node.invoice_features());
7115         let (route,_, _, _) = get_route_and_payment_hash!(nodes[1], nodes[0], payment_params, 3000000, 30);
7116         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7117
7118         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7119         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7120         assert_eq!(revoked_txn[0].output.len(), 4);
7121         assert_eq!(revoked_txn[0].input.len(), 1);
7122         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7123         let revoked_txid = revoked_txn[0].txid();
7124
7125         let mut penalty_sum = 0;
7126         for outp in revoked_txn[0].output.iter() {
7127                 if outp.script_pubkey.is_v0_p2wsh() {
7128                         penalty_sum += outp.value;
7129                 }
7130         }
7131
7132         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7133         let header_114 = connect_blocks(&nodes[1], 14);
7134
7135         // Actually revoke tx by claiming a HTLC
7136         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7137         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
7138         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7139         check_added_monitors!(nodes[1], 1);
7140
7141         // One or more justice tx should have been broadcast, check it
7142         let penalty_1;
7143         let feerate_1;
7144         {
7145                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7146                 assert_eq!(node_txn.len(), 1); // justice tx (broadcasted from ChannelMonitor)
7147                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7148                 assert_eq!(node_txn[0].output.len(), 1);
7149                 check_spends!(node_txn[0], revoked_txn[0]);
7150                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7151                 feerate_1 = fee_1 * 1000 / node_txn[0].weight() as u64;
7152                 penalty_1 = node_txn[0].txid();
7153                 node_txn.clear();
7154         };
7155
7156         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7157         connect_blocks(&nodes[1], 15);
7158         let mut penalty_2 = penalty_1;
7159         let mut feerate_2 = 0;
7160         {
7161                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7162                 assert_eq!(node_txn.len(), 1);
7163                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7164                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7165                         assert_eq!(node_txn[0].output.len(), 1);
7166                         check_spends!(node_txn[0], revoked_txn[0]);
7167                         penalty_2 = node_txn[0].txid();
7168                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7169                         assert_ne!(penalty_2, penalty_1);
7170                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7171                         feerate_2 = fee_2 * 1000 / node_txn[0].weight() as u64;
7172                         // Verify 25% bump heuristic
7173                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7174                         node_txn.clear();
7175                 }
7176         }
7177         assert_ne!(feerate_2, 0);
7178
7179         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7180         connect_blocks(&nodes[1], 1);
7181         let penalty_3;
7182         let mut feerate_3 = 0;
7183         {
7184                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7185                 assert_eq!(node_txn.len(), 1);
7186                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7187                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7188                         assert_eq!(node_txn[0].output.len(), 1);
7189                         check_spends!(node_txn[0], revoked_txn[0]);
7190                         penalty_3 = node_txn[0].txid();
7191                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7192                         assert_ne!(penalty_3, penalty_2);
7193                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7194                         feerate_3 = fee_3 * 1000 / node_txn[0].weight() as u64;
7195                         // Verify 25% bump heuristic
7196                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7197                         node_txn.clear();
7198                 }
7199         }
7200         assert_ne!(feerate_3, 0);
7201
7202         nodes[1].node.get_and_clear_pending_events();
7203         nodes[1].node.get_and_clear_pending_msg_events();
7204 }
7205
7206 #[test]
7207 fn test_bump_penalty_txn_on_revoked_htlcs() {
7208         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7209         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7210
7211         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7212         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
7213         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7214         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7215         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7216
7217         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000);
7218         // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
7219         let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), 50).with_features(nodes[1].node.invoice_features());
7220         let scorer = test_utils::TestScorer::new();
7221         let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7222         let route = get_route(&nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph.read_only(), None,
7223                 3_000_000, 50, nodes[0].logger, &scorer, &random_seed_bytes).unwrap();
7224         let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
7225         let payment_params = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id(), 50).with_features(nodes[0].node.invoice_features());
7226         let route = get_route(&nodes[1].node.get_our_node_id(), &payment_params, &nodes[1].network_graph.read_only(), None,
7227                 3_000_000, 50, nodes[0].logger, &scorer, &random_seed_bytes).unwrap();
7228         send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
7229
7230         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7231         assert_eq!(revoked_local_txn[0].input.len(), 1);
7232         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7233
7234         // Revoke local commitment tx
7235         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7236
7237         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
7238         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7239         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
7240         check_closed_broadcast!(nodes[1], true);
7241         check_added_monitors!(nodes[1], 1);
7242         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
7243         connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
7244
7245         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
7246         assert_eq!(revoked_htlc_txn.len(), 2);
7247
7248         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7249         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7250         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7251
7252         assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7253         assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7254         assert_eq!(revoked_htlc_txn[1].output.len(), 1);
7255         check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7256
7257         // Broadcast set of revoked txn on A
7258         let hash_128 = connect_blocks(&nodes[0], 40);
7259         let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
7260         connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
7261         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
7262         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] });
7263         let events = nodes[0].node.get_and_clear_pending_events();
7264         expect_pending_htlcs_forwardable_from_events!(nodes[0], events[0..1], true);
7265         match events.last().unwrap() {
7266                 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
7267                 _ => panic!("Unexpected event"),
7268         }
7269         let first;
7270         let feerate_1;
7271         let penalty_txn;
7272         {
7273                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7274                 assert_eq!(node_txn.len(), 4); // 3 penalty txn on revoked commitment tx + 1 penalty tnx on revoked HTLC txn
7275                 // Verify claim tx are spending revoked HTLC txn
7276
7277                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
7278                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
7279                 // which are included in the same block (they are broadcasted because we scan the
7280                 // transactions linearly and generate claims as we go, they likely should be removed in the
7281                 // future).
7282                 assert_eq!(node_txn[0].input.len(), 1);
7283                 check_spends!(node_txn[0], revoked_local_txn[0]);
7284                 assert_eq!(node_txn[1].input.len(), 1);
7285                 check_spends!(node_txn[1], revoked_local_txn[0]);
7286                 assert_eq!(node_txn[2].input.len(), 1);
7287                 check_spends!(node_txn[2], revoked_local_txn[0]);
7288
7289                 // Each of the three justice transactions claim a separate (single) output of the three
7290                 // available, which we check here:
7291                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
7292                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
7293                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
7294
7295                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7296                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7297
7298                 // node_txn[3] spends the revoked outputs from the revoked_htlc_txn (which only have one
7299                 // output, checked above).
7300                 assert_eq!(node_txn[3].input.len(), 2);
7301                 assert_eq!(node_txn[3].output.len(), 1);
7302                 check_spends!(node_txn[3], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7303
7304                 first = node_txn[3].txid();
7305                 // Store both feerates for later comparison
7306                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[3].output[0].value;
7307                 feerate_1 = fee_1 * 1000 / node_txn[3].weight() as u64;
7308                 penalty_txn = vec![node_txn[2].clone()];
7309                 node_txn.clear();
7310         }
7311
7312         // Connect one more block to see if bumped penalty are issued for HTLC txn
7313         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
7314         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
7315         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
7316         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
7317
7318         // Few more blocks to confirm penalty txn
7319         connect_blocks(&nodes[0], 4);
7320         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7321         let header_144 = connect_blocks(&nodes[0], 9);
7322         let node_txn = {
7323                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7324                 assert_eq!(node_txn.len(), 1);
7325
7326                 assert_eq!(node_txn[0].input.len(), 2);
7327                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7328                 // Verify bumped tx is different and 25% bump heuristic
7329                 assert_ne!(first, node_txn[0].txid());
7330                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7331                 let feerate_2 = fee_2 * 1000 / node_txn[0].weight() as u64;
7332                 assert!(feerate_2 * 100 > feerate_1 * 125);
7333                 let txn = vec![node_txn[0].clone()];
7334                 node_txn.clear();
7335                 txn
7336         };
7337         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7338         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
7339         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
7340         connect_blocks(&nodes[0], 20);
7341         {
7342                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7343                 // We verify than no new transaction has been broadcast because previously
7344                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7345                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7346                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7347                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7348                 // up bumped justice generation.
7349                 assert_eq!(node_txn.len(), 0);
7350                 node_txn.clear();
7351         }
7352         check_closed_broadcast!(nodes[0], true);
7353         check_added_monitors!(nodes[0], 1);
7354 }
7355
7356 #[test]
7357 fn test_bump_penalty_txn_on_remote_commitment() {
7358         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7359         // we're able to claim outputs on remote commitment transaction before timelocks expiration
7360
7361         // Create 2 HTLCs
7362         // Provide preimage for one
7363         // Check aggregation
7364
7365         let chanmon_cfgs = create_chanmon_cfgs(2);
7366         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7367         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7368         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7369
7370         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000);
7371         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 3_000_000);
7372         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7373
7374         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7375         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7376         assert_eq!(remote_txn[0].output.len(), 4);
7377         assert_eq!(remote_txn[0].input.len(), 1);
7378         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7379
7380         // Claim a HTLC without revocation (provide B monitor with preimage)
7381         nodes[1].node.claim_funds(payment_preimage);
7382         expect_payment_claimed!(nodes[1], payment_hash, 3_000_000);
7383         mine_transaction(&nodes[1], &remote_txn[0]);
7384         check_added_monitors!(nodes[1], 2);
7385         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7386
7387         // One or more claim tx should have been broadcast, check it
7388         let timeout;
7389         let preimage;
7390         let preimage_bump;
7391         let feerate_timeout;
7392         let feerate_preimage;
7393         {
7394                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7395                 // 3 transactions including:
7396                 //   preimage and timeout sweeps from remote commitment + preimage sweep bump
7397                 assert_eq!(node_txn.len(), 3);
7398                 assert_eq!(node_txn[0].input.len(), 1);
7399                 assert_eq!(node_txn[1].input.len(), 1);
7400                 assert_eq!(node_txn[2].input.len(), 1);
7401                 check_spends!(node_txn[0], remote_txn[0]);
7402                 check_spends!(node_txn[1], remote_txn[0]);
7403                 check_spends!(node_txn[2], remote_txn[0]);
7404
7405                 preimage = node_txn[0].txid();
7406                 let index = node_txn[0].input[0].previous_output.vout;
7407                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7408                 feerate_preimage = fee * 1000 / node_txn[0].weight() as u64;
7409
7410                 let (preimage_bump_tx, timeout_tx) = if node_txn[2].input[0].previous_output == node_txn[0].input[0].previous_output {
7411                         (node_txn[2].clone(), node_txn[1].clone())
7412                 } else {
7413                         (node_txn[1].clone(), node_txn[2].clone())
7414                 };
7415
7416                 preimage_bump = preimage_bump_tx;
7417                 check_spends!(preimage_bump, remote_txn[0]);
7418                 assert_eq!(node_txn[0].input[0].previous_output, preimage_bump.input[0].previous_output);
7419
7420                 timeout = timeout_tx.txid();
7421                 let index = timeout_tx.input[0].previous_output.vout;
7422                 let fee = remote_txn[0].output[index as usize].value - timeout_tx.output[0].value;
7423                 feerate_timeout = fee * 1000 / timeout_tx.weight() as u64;
7424
7425                 node_txn.clear();
7426         };
7427         assert_ne!(feerate_timeout, 0);
7428         assert_ne!(feerate_preimage, 0);
7429
7430         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7431         connect_blocks(&nodes[1], 15);
7432         {
7433                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7434                 assert_eq!(node_txn.len(), 1);
7435                 assert_eq!(node_txn[0].input.len(), 1);
7436                 assert_eq!(preimage_bump.input.len(), 1);
7437                 check_spends!(node_txn[0], remote_txn[0]);
7438                 check_spends!(preimage_bump, remote_txn[0]);
7439
7440                 let index = preimage_bump.input[0].previous_output.vout;
7441                 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
7442                 let new_feerate = fee * 1000 / preimage_bump.weight() as u64;
7443                 assert!(new_feerate * 100 > feerate_timeout * 125);
7444                 assert_ne!(timeout, preimage_bump.txid());
7445
7446                 let index = node_txn[0].input[0].previous_output.vout;
7447                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7448                 let new_feerate = fee * 1000 / node_txn[0].weight() as u64;
7449                 assert!(new_feerate * 100 > feerate_preimage * 125);
7450                 assert_ne!(preimage, node_txn[0].txid());
7451
7452                 node_txn.clear();
7453         }
7454
7455         nodes[1].node.get_and_clear_pending_events();
7456         nodes[1].node.get_and_clear_pending_msg_events();
7457 }
7458
7459 #[test]
7460 fn test_counterparty_raa_skip_no_crash() {
7461         // Previously, if our counterparty sent two RAAs in a row without us having provided a
7462         // commitment transaction, we would have happily carried on and provided them the next
7463         // commitment transaction based on one RAA forward. This would probably eventually have led to
7464         // channel closure, but it would not have resulted in funds loss. Still, our
7465         // EnforcingSigner would have panicked as it doesn't like jumps into the future. Here, we
7466         // check simply that the channel is closed in response to such an RAA, but don't check whether
7467         // we decide to punish our counterparty for revoking their funds (as we don't currently
7468         // implement that).
7469         let chanmon_cfgs = create_chanmon_cfgs(2);
7470         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7471         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7472         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7473         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
7474
7475         let per_commitment_secret;
7476         let next_per_commitment_point;
7477         {
7478                 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
7479                 let mut guard = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
7480                 let keys = guard.channel_by_id.get_mut(&channel_id).unwrap().get_signer();
7481
7482                 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7483
7484                 // Make signer believe we got a counterparty signature, so that it allows the revocation
7485                 keys.get_enforcement_state().last_holder_commitment -= 1;
7486                 per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
7487
7488                 // Must revoke without gaps
7489                 keys.get_enforcement_state().last_holder_commitment -= 1;
7490                 keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
7491
7492                 keys.get_enforcement_state().last_holder_commitment -= 1;
7493                 next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7494                         &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7495         }
7496
7497         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7498                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
7499         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7500         check_added_monitors!(nodes[1], 1);
7501         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Received an unexpected revoke_and_ack".to_string() });
7502 }
7503
7504 #[test]
7505 fn test_bump_txn_sanitize_tracking_maps() {
7506         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7507         // verify we clean then right after expiration of ANTI_REORG_DELAY.
7508
7509         let chanmon_cfgs = create_chanmon_cfgs(2);
7510         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7511         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7512         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7513
7514         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000);
7515         // Lock HTLC in both directions
7516         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000);
7517         let (_, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000);
7518
7519         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7520         assert_eq!(revoked_local_txn[0].input.len(), 1);
7521         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7522
7523         // Revoke local commitment tx
7524         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
7525
7526         // Broadcast set of revoked txn on A
7527         connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
7528         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[0], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_2 }]);
7529         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
7530
7531         mine_transaction(&nodes[0], &revoked_local_txn[0]);
7532         check_closed_broadcast!(nodes[0], true);
7533         check_added_monitors!(nodes[0], 1);
7534         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
7535         let penalty_txn = {
7536                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7537                 assert_eq!(node_txn.len(), 3); //ChannelMonitor: justice txn * 3
7538                 check_spends!(node_txn[0], revoked_local_txn[0]);
7539                 check_spends!(node_txn[1], revoked_local_txn[0]);
7540                 check_spends!(node_txn[2], revoked_local_txn[0]);
7541                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7542                 node_txn.clear();
7543                 penalty_txn
7544         };
7545         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
7546         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
7547         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7548         {
7549                 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(OutPoint { txid: chan.3.txid(), index: 0 }).unwrap();
7550                 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
7551                 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
7552         }
7553 }
7554
7555 #[test]
7556 fn test_pending_claimed_htlc_no_balance_underflow() {
7557         // Tests that if we have a pending outbound HTLC as well as a claimed-but-not-fully-removed
7558         // HTLC we will not underflow when we call `Channel::get_balance_msat()`.
7559         let chanmon_cfgs = create_chanmon_cfgs(2);
7560         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7561         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7562         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7563         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 0);
7564
7565         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1_010_000);
7566         nodes[1].node.claim_funds(payment_preimage);
7567         expect_payment_claimed!(nodes[1], payment_hash, 1_010_000);
7568         check_added_monitors!(nodes[1], 1);
7569         let fulfill_ev = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7570
7571         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &fulfill_ev.update_fulfill_htlcs[0]);
7572         expect_payment_sent_without_paths!(nodes[0], payment_preimage);
7573         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &fulfill_ev.commitment_signed);
7574         check_added_monitors!(nodes[0], 1);
7575         let (_raa, _cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7576
7577         // At this point nodes[1] has received 1,010k msat (10k msat more than their reserve) and can
7578         // send an HTLC back (though it will go in the holding cell). Send an HTLC back and check we
7579         // can get our balance.
7580
7581         // Get a route from nodes[1] to nodes[0] by getting a route going the other way and then flip
7582         // the public key of the only hop. This works around ChannelDetails not showing the
7583         // almost-claimed HTLC as available balance.
7584         let (mut route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[1], 10_000);
7585         route.payment_params = None; // This is all wrong, but unnecessary
7586         route.paths[0][0].pubkey = nodes[0].node.get_our_node_id();
7587         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[0]);
7588         nodes[1].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
7589
7590         assert_eq!(nodes[1].node.list_channels()[0].balance_msat, 1_000_000);
7591 }
7592
7593 #[test]
7594 fn test_channel_conf_timeout() {
7595         // Tests that, for inbound channels, we give up on them if the funding transaction does not
7596         // confirm within 2016 blocks, as recommended by BOLT 2.
7597         let chanmon_cfgs = create_chanmon_cfgs(2);
7598         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7599         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7600         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7601
7602         let _funding_tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 1_000_000, 100_000);
7603
7604         // The outbound node should wait forever for confirmation:
7605         // This matches `channel::FUNDING_CONF_DEADLINE_BLOCKS` and BOLT 2's suggested timeout, thus is
7606         // copied here instead of directly referencing the constant.
7607         connect_blocks(&nodes[0], 2016);
7608         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7609
7610         // The inbound node should fail the channel after exactly 2016 blocks
7611         connect_blocks(&nodes[1], 2015);
7612         check_added_monitors!(nodes[1], 0);
7613         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7614
7615         connect_blocks(&nodes[1], 1);
7616         check_added_monitors!(nodes[1], 1);
7617         check_closed_event!(nodes[1], 1, ClosureReason::FundingTimedOut);
7618         let close_ev = nodes[1].node.get_and_clear_pending_msg_events();
7619         assert_eq!(close_ev.len(), 1);
7620         match close_ev[0] {
7621                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, ref node_id } => {
7622                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7623                         assert_eq!(msg.data, "Channel closed because funding transaction failed to confirm within 2016 blocks");
7624                 },
7625                 _ => panic!("Unexpected event"),
7626         }
7627 }
7628
7629 #[test]
7630 fn test_override_channel_config() {
7631         let chanmon_cfgs = create_chanmon_cfgs(2);
7632         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7633         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7634         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7635
7636         // Node0 initiates a channel to node1 using the override config.
7637         let mut override_config = UserConfig::default();
7638         override_config.channel_handshake_config.our_to_self_delay = 200;
7639
7640         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
7641
7642         // Assert the channel created by node0 is using the override config.
7643         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7644         assert_eq!(res.channel_flags, 0);
7645         assert_eq!(res.to_self_delay, 200);
7646 }
7647
7648 #[test]
7649 fn test_override_0msat_htlc_minimum() {
7650         let mut zero_config = UserConfig::default();
7651         zero_config.channel_handshake_config.our_htlc_minimum_msat = 0;
7652         let chanmon_cfgs = create_chanmon_cfgs(2);
7653         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7654         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
7655         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7656
7657         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
7658         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7659         assert_eq!(res.htlc_minimum_msat, 1);
7660
7661         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &res);
7662         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7663         assert_eq!(res.htlc_minimum_msat, 1);
7664 }
7665
7666 #[test]
7667 fn test_channel_update_has_correct_htlc_maximum_msat() {
7668         // Tests that the `ChannelUpdate` message has the correct values for `htlc_maximum_msat` set.
7669         // Bolt 7 specifies that if present `htlc_maximum_msat`:
7670         // 1. MUST be set to less than or equal to the channel capacity. In LDK, this is capped to
7671         // 90% of the `channel_value`.
7672         // 2. MUST be set to less than or equal to the `max_htlc_value_in_flight_msat` received from the peer.
7673
7674         let mut config_30_percent = UserConfig::default();
7675         config_30_percent.channel_handshake_config.announced_channel = true;
7676         config_30_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 30;
7677         let mut config_50_percent = UserConfig::default();
7678         config_50_percent.channel_handshake_config.announced_channel = true;
7679         config_50_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 50;
7680         let mut config_95_percent = UserConfig::default();
7681         config_95_percent.channel_handshake_config.announced_channel = true;
7682         config_95_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 95;
7683         let mut config_100_percent = UserConfig::default();
7684         config_100_percent.channel_handshake_config.announced_channel = true;
7685         config_100_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 100;
7686
7687         let chanmon_cfgs = create_chanmon_cfgs(4);
7688         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
7689         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[Some(config_30_percent), Some(config_50_percent), Some(config_95_percent), Some(config_100_percent)]);
7690         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
7691
7692         let channel_value_satoshis = 100000;
7693         let channel_value_msat = channel_value_satoshis * 1000;
7694         let channel_value_30_percent_msat = (channel_value_msat as f64 * 0.3) as u64;
7695         let channel_value_50_percent_msat = (channel_value_msat as f64 * 0.5) as u64;
7696         let channel_value_90_percent_msat = (channel_value_msat as f64 * 0.9) as u64;
7697
7698         let (node_0_chan_update, node_1_chan_update, _, _)  = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value_satoshis, 10001);
7699         let (node_2_chan_update, node_3_chan_update, _, _)  = create_announced_chan_between_nodes_with_value(&nodes, 2, 3, channel_value_satoshis, 10001);
7700
7701         // Assert that `node[0]`'s `ChannelUpdate` is capped at 50 percent of the `channel_value`, as
7702         // that's the value of `node[1]`'s `holder_max_htlc_value_in_flight_msat`.
7703         assert_eq!(node_0_chan_update.contents.htlc_maximum_msat, channel_value_50_percent_msat);
7704         // Assert that `node[1]`'s `ChannelUpdate` is capped at 30 percent of the `channel_value`, as
7705         // that's the value of `node[0]`'s `holder_max_htlc_value_in_flight_msat`.
7706         assert_eq!(node_1_chan_update.contents.htlc_maximum_msat, channel_value_30_percent_msat);
7707
7708         // Assert that `node[2]`'s `ChannelUpdate` is capped at 90 percent of the `channel_value`, as
7709         // the value of `node[3]`'s `holder_max_htlc_value_in_flight_msat` (100%), exceeds 90% of the
7710         // `channel_value`.
7711         assert_eq!(node_2_chan_update.contents.htlc_maximum_msat, channel_value_90_percent_msat);
7712         // Assert that `node[3]`'s `ChannelUpdate` is capped at 90 percent of the `channel_value`, as
7713         // the value of `node[2]`'s `holder_max_htlc_value_in_flight_msat` (95%), exceeds 90% of the
7714         // `channel_value`.
7715         assert_eq!(node_3_chan_update.contents.htlc_maximum_msat, channel_value_90_percent_msat);
7716 }
7717
7718 #[test]
7719 fn test_manually_accept_inbound_channel_request() {
7720         let mut manually_accept_conf = UserConfig::default();
7721         manually_accept_conf.manually_accept_inbound_channels = true;
7722         let chanmon_cfgs = create_chanmon_cfgs(2);
7723         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7724         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(manually_accept_conf.clone())]);
7725         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7726
7727         let temp_channel_id = nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, Some(manually_accept_conf)).unwrap();
7728         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7729
7730         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &res);
7731
7732         // Assert that `nodes[1]` has no `MessageSendEvent::SendAcceptChannel` in `msg_events` before
7733         // accepting the inbound channel request.
7734         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7735
7736         let events = nodes[1].node.get_and_clear_pending_events();
7737         match events[0] {
7738                 Event::OpenChannelRequest { temporary_channel_id, .. } => {
7739                         nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 23).unwrap();
7740                 }
7741                 _ => panic!("Unexpected event"),
7742         }
7743
7744         let accept_msg_ev = nodes[1].node.get_and_clear_pending_msg_events();
7745         assert_eq!(accept_msg_ev.len(), 1);
7746
7747         match accept_msg_ev[0] {
7748                 MessageSendEvent::SendAcceptChannel { ref node_id, .. } => {
7749                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7750                 }
7751                 _ => panic!("Unexpected event"),
7752         }
7753
7754         nodes[1].node.force_close_broadcasting_latest_txn(&temp_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
7755
7756         let close_msg_ev = nodes[1].node.get_and_clear_pending_msg_events();
7757         assert_eq!(close_msg_ev.len(), 1);
7758
7759         let events = nodes[1].node.get_and_clear_pending_events();
7760         match events[0] {
7761                 Event::ChannelClosed { user_channel_id, .. } => {
7762                         assert_eq!(user_channel_id, 23);
7763                 }
7764                 _ => panic!("Unexpected event"),
7765         }
7766 }
7767
7768 #[test]
7769 fn test_manually_reject_inbound_channel_request() {
7770         let mut manually_accept_conf = UserConfig::default();
7771         manually_accept_conf.manually_accept_inbound_channels = true;
7772         let chanmon_cfgs = create_chanmon_cfgs(2);
7773         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7774         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(manually_accept_conf.clone())]);
7775         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7776
7777         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, Some(manually_accept_conf)).unwrap();
7778         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7779
7780         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &res);
7781
7782         // Assert that `nodes[1]` has no `MessageSendEvent::SendAcceptChannel` in `msg_events` before
7783         // rejecting the inbound channel request.
7784         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7785
7786         let events = nodes[1].node.get_and_clear_pending_events();
7787         match events[0] {
7788                 Event::OpenChannelRequest { temporary_channel_id, .. } => {
7789                         nodes[1].node.force_close_broadcasting_latest_txn(&temporary_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
7790                 }
7791                 _ => panic!("Unexpected event"),
7792         }
7793
7794         let close_msg_ev = nodes[1].node.get_and_clear_pending_msg_events();
7795         assert_eq!(close_msg_ev.len(), 1);
7796
7797         match close_msg_ev[0] {
7798                 MessageSendEvent::HandleError { ref node_id, .. } => {
7799                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7800                 }
7801                 _ => panic!("Unexpected event"),
7802         }
7803         check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
7804 }
7805
7806 #[test]
7807 fn test_reject_funding_before_inbound_channel_accepted() {
7808         // This tests that when `UserConfig::manually_accept_inbound_channels` is set to true, inbound
7809         // channels must to be manually accepted through `ChannelManager::accept_inbound_channel` by
7810         // the node operator before the counterparty sends a `FundingCreated` message. If a
7811         // `FundingCreated` message is received before the channel is accepted, it should be rejected
7812         // and the channel should be closed.
7813         let mut manually_accept_conf = UserConfig::default();
7814         manually_accept_conf.manually_accept_inbound_channels = true;
7815         let chanmon_cfgs = create_chanmon_cfgs(2);
7816         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7817         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(manually_accept_conf.clone())]);
7818         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7819
7820         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, Some(manually_accept_conf)).unwrap();
7821         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7822         let temp_channel_id = res.temporary_channel_id;
7823
7824         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &res);
7825
7826         // Assert that `nodes[1]` has no `MessageSendEvent::SendAcceptChannel` in the `msg_events`.
7827         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7828
7829         // Clear the `Event::OpenChannelRequest` event without responding to the request.
7830         nodes[1].node.get_and_clear_pending_events();
7831
7832         // Get the `AcceptChannel` message of `nodes[1]` without calling
7833         // `ChannelManager::accept_inbound_channel`, which generates a
7834         // `MessageSendEvent::SendAcceptChannel` event. The message is passed to `nodes[0]`
7835         // `handle_accept_channel`, which is required in order for `create_funding_transaction` to
7836         // succeed when `nodes[0]` is passed to it.
7837         let accept_chan_msg = {
7838                 let mut node_1_per_peer_lock;
7839                 let mut node_1_peer_state_lock;
7840                 let channel =  get_channel_ref!(&nodes[1], nodes[0], node_1_per_peer_lock, node_1_peer_state_lock, temp_channel_id);
7841                 channel.get_accept_channel_message()
7842         };
7843         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_chan_msg);
7844
7845         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 42);
7846
7847         nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
7848         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
7849
7850         // The `funding_created_msg` should be rejected by `nodes[1]` as it hasn't accepted the channel
7851         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
7852
7853         let close_msg_ev = nodes[1].node.get_and_clear_pending_msg_events();
7854         assert_eq!(close_msg_ev.len(), 1);
7855
7856         let expected_err = "FundingCreated message received before the channel was accepted";
7857         match close_msg_ev[0] {
7858                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, ref node_id, } => {
7859                         assert_eq!(msg.channel_id, temp_channel_id);
7860                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7861                         assert_eq!(msg.data, expected_err);
7862                 }
7863                 _ => panic!("Unexpected event"),
7864         }
7865
7866         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: expected_err.to_string() });
7867 }
7868
7869 #[test]
7870 fn test_can_not_accept_inbound_channel_twice() {
7871         let mut manually_accept_conf = UserConfig::default();
7872         manually_accept_conf.manually_accept_inbound_channels = true;
7873         let chanmon_cfgs = create_chanmon_cfgs(2);
7874         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7875         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(manually_accept_conf.clone())]);
7876         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7877
7878         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, Some(manually_accept_conf)).unwrap();
7879         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7880
7881         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &res);
7882
7883         // Assert that `nodes[1]` has no `MessageSendEvent::SendAcceptChannel` in `msg_events` before
7884         // accepting the inbound channel request.
7885         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7886
7887         let events = nodes[1].node.get_and_clear_pending_events();
7888         match events[0] {
7889                 Event::OpenChannelRequest { temporary_channel_id, .. } => {
7890                         nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
7891                         let api_res = nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0);
7892                         match api_res {
7893                                 Err(APIError::APIMisuseError { err }) => {
7894                                         assert_eq!(err, "The channel isn't currently awaiting to be accepted.");
7895                                 },
7896                                 Ok(_) => panic!("Channel shouldn't be possible to be accepted twice"),
7897                                 Err(_) => panic!("Unexpected Error"),
7898                         }
7899                 }
7900                 _ => panic!("Unexpected event"),
7901         }
7902
7903         // Ensure that the channel wasn't closed after attempting to accept it twice.
7904         let accept_msg_ev = nodes[1].node.get_and_clear_pending_msg_events();
7905         assert_eq!(accept_msg_ev.len(), 1);
7906
7907         match accept_msg_ev[0] {
7908                 MessageSendEvent::SendAcceptChannel { ref node_id, .. } => {
7909                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7910                 }
7911                 _ => panic!("Unexpected event"),
7912         }
7913 }
7914
7915 #[test]
7916 fn test_can_not_accept_unknown_inbound_channel() {
7917         let chanmon_cfg = create_chanmon_cfgs(2);
7918         let node_cfg = create_node_cfgs(2, &chanmon_cfg);
7919         let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
7920         let nodes = create_network(2, &node_cfg, &node_chanmgr);
7921
7922         let unknown_channel_id = [0; 32];
7923         let api_res = nodes[0].node.accept_inbound_channel(&unknown_channel_id, &nodes[1].node.get_our_node_id(), 0);
7924         match api_res {
7925                 Err(APIError::ChannelUnavailable { err }) => {
7926                         assert_eq!(err, format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(unknown_channel_id), nodes[1].node.get_our_node_id()));
7927                 },
7928                 Ok(_) => panic!("It shouldn't be possible to accept an unkown channel"),
7929                 Err(_) => panic!("Unexpected Error"),
7930         }
7931 }
7932
7933 #[test]
7934 fn test_simple_mpp() {
7935         // Simple test of sending a multi-path payment.
7936         let chanmon_cfgs = create_chanmon_cfgs(4);
7937         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
7938         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
7939         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
7940
7941         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
7942         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
7943         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
7944         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
7945
7946         let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
7947         let path = route.paths[0].clone();
7948         route.paths.push(path);
7949         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
7950         route.paths[0][0].short_channel_id = chan_1_id;
7951         route.paths[0][1].short_channel_id = chan_3_id;
7952         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
7953         route.paths[1][0].short_channel_id = chan_2_id;
7954         route.paths[1][1].short_channel_id = chan_4_id;
7955         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
7956         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
7957 }
7958
7959 #[test]
7960 fn test_preimage_storage() {
7961         // Simple test of payment preimage storage allowing no client-side storage to claim payments
7962         let chanmon_cfgs = create_chanmon_cfgs(2);
7963         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7964         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7965         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7966
7967         create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
7968
7969         {
7970                 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, None).unwrap();
7971                 let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
7972                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
7973                 check_added_monitors!(nodes[0], 1);
7974                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7975                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7976                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7977                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7978         }
7979         // Note that after leaving the above scope we have no knowledge of any arguments or return
7980         // values from previous calls.
7981         expect_pending_htlcs_forwardable!(nodes[1]);
7982         let events = nodes[1].node.get_and_clear_pending_events();
7983         assert_eq!(events.len(), 1);
7984         match events[0] {
7985                 Event::PaymentClaimable { ref purpose, .. } => {
7986                         match &purpose {
7987                                 PaymentPurpose::InvoicePayment { payment_preimage, .. } => {
7988                                         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
7989                                 },
7990                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
7991                         }
7992                 },
7993                 _ => panic!("Unexpected event"),
7994         }
7995 }
7996
7997 #[test]
7998 #[allow(deprecated)]
7999 fn test_secret_timeout() {
8000         // Simple test of payment secret storage time outs. After
8001         // `create_inbound_payment(_for_hash)_legacy` is removed, this test will be removed as well.
8002         let chanmon_cfgs = create_chanmon_cfgs(2);
8003         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8004         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8005         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8006
8007         create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
8008
8009         let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment_legacy(Some(100_000), 2).unwrap();
8010
8011         // We should fail to register the same payment hash twice, at least until we've connected a
8012         // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8013         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash_legacy(payment_hash, Some(100_000), 2) {
8014                 assert_eq!(err, "Duplicate payment hash");
8015         } else { panic!(); }
8016         let mut block = {
8017                 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8018                 Block {
8019                         header: BlockHeader {
8020                                 version: 0x2000000,
8021                                 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8022                                 merkle_root: TxMerkleNode::all_zeros(),
8023                                 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8024                         txdata: vec![],
8025                 }
8026         };
8027         connect_block(&nodes[1], &block);
8028         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash_legacy(payment_hash, Some(100_000), 2) {
8029                 assert_eq!(err, "Duplicate payment hash");
8030         } else { panic!(); }
8031
8032         // If we then connect the second block, we should be able to register the same payment hash
8033         // again (this time getting a new payment secret).
8034         block.header.prev_blockhash = block.header.block_hash();
8035         block.header.time += 1;
8036         connect_block(&nodes[1], &block);
8037         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash_legacy(payment_hash, Some(100_000), 2).unwrap();
8038         assert_ne!(payment_secret_1, our_payment_secret);
8039
8040         {
8041                 let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
8042                 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret), PaymentId(payment_hash.0)).unwrap();
8043                 check_added_monitors!(nodes[0], 1);
8044                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8045                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8046                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8047                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8048         }
8049         // Note that after leaving the above scope we have no knowledge of any arguments or return
8050         // values from previous calls.
8051         expect_pending_htlcs_forwardable!(nodes[1]);
8052         let events = nodes[1].node.get_and_clear_pending_events();
8053         assert_eq!(events.len(), 1);
8054         match events[0] {
8055                 Event::PaymentClaimable { purpose: PaymentPurpose::InvoicePayment { payment_preimage, payment_secret }, .. } => {
8056                         assert!(payment_preimage.is_none());
8057                         assert_eq!(payment_secret, our_payment_secret);
8058                         // We don't actually have the payment preimage with which to claim this payment!
8059                 },
8060                 _ => panic!("Unexpected event"),
8061         }
8062 }
8063
8064 #[test]
8065 fn test_bad_secret_hash() {
8066         // Simple test of unregistered payment hash/invalid payment secret handling
8067         let chanmon_cfgs = create_chanmon_cfgs(2);
8068         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8069         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8070         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8071
8072         create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
8073
8074         let random_payment_hash = PaymentHash([42; 32]);
8075         let random_payment_secret = PaymentSecret([43; 32]);
8076         let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, None).unwrap();
8077         let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
8078
8079         // All the below cases should end up being handled exactly identically, so we macro the
8080         // resulting events.
8081         macro_rules! handle_unknown_invalid_payment_data {
8082                 ($payment_hash: expr) => {
8083                         check_added_monitors!(nodes[0], 1);
8084                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8085                         let payment_event = SendEvent::from_event(events.pop().unwrap());
8086                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8087                         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8088
8089                         // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8090                         // again to process the pending backwards-failure of the HTLC
8091                         expect_pending_htlcs_forwardable!(nodes[1]);
8092                         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment{ payment_hash: $payment_hash }]);
8093                         check_added_monitors!(nodes[1], 1);
8094
8095                         // We should fail the payment back
8096                         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8097                         match events.pop().unwrap() {
8098                                 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8099                                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8100                                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8101                                 },
8102                                 _ => panic!("Unexpected event"),
8103                         }
8104                 }
8105         }
8106
8107         let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8108         // Error data is the HTLC value (100,000) and current block height
8109         let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8110
8111         // Send a payment with the right payment hash but the wrong payment secret
8112         nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
8113         handle_unknown_invalid_payment_data!(our_payment_hash);
8114         expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8115
8116         // Send a payment with a random payment hash, but the right payment secret
8117         nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret), PaymentId(random_payment_hash.0)).unwrap();
8118         handle_unknown_invalid_payment_data!(random_payment_hash);
8119         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8120
8121         // Send a payment with a random payment hash and random payment secret
8122         nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret), PaymentId(random_payment_hash.0)).unwrap();
8123         handle_unknown_invalid_payment_data!(random_payment_hash);
8124         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8125 }
8126
8127 #[test]
8128 fn test_update_err_monitor_lockdown() {
8129         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8130         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8131         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateStatus
8132         // error.
8133         //
8134         // This scenario may happen in a watchtower setup, where watchtower process a block height
8135         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8136         // commitment at same time.
8137
8138         let chanmon_cfgs = create_chanmon_cfgs(2);
8139         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8140         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8141         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8142
8143         // Create some initial channel
8144         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
8145         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8146
8147         // Rebalance the network to generate htlc in the two directions
8148         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8149
8150         // Route a HTLC from node 0 to node 1 (but don't settle)
8151         let (preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 9_000_000);
8152
8153         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8154         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8155         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8156         let persister = test_utils::TestPersister::new();
8157         let watchtower = {
8158                 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
8159                 let mut w = test_utils::TestVecWriter(Vec::new());
8160                 monitor.write(&mut w).unwrap();
8161                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8162                                 &mut io::Cursor::new(&w.0), (nodes[0].keys_manager, nodes[0].keys_manager)).unwrap().1;
8163                 assert!(new_monitor == *monitor);
8164                 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);
8165                 assert_eq!(watchtower.watch_channel(outpoint, new_monitor), ChannelMonitorUpdateStatus::Completed);
8166                 watchtower
8167         };
8168         let header = BlockHeader { version: 0x20000000, prev_blockhash: BlockHash::all_zeros(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
8169         let block = Block { header, txdata: vec![] };
8170         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8171         // transaction lock time requirements here.
8172         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (block.clone(), 0));
8173         watchtower.chain_monitor.block_connected(&block, 200);
8174
8175         // Try to update ChannelMonitor
8176         nodes[1].node.claim_funds(preimage);
8177         check_added_monitors!(nodes[1], 1);
8178         expect_payment_claimed!(nodes[1], payment_hash, 9_000_000);
8179
8180         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8181         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8182         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8183         {
8184                 let mut node_0_per_peer_lock;
8185                 let mut node_0_peer_state_lock;
8186                 let mut channel = get_channel_ref!(nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, chan_1.2);
8187                 if let Ok(update) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8188                         assert_eq!(watchtower.chain_monitor.update_channel(outpoint, &update), ChannelMonitorUpdateStatus::PermanentFailure);
8189                         assert_eq!(nodes[0].chain_monitor.update_channel(outpoint, &update), ChannelMonitorUpdateStatus::Completed);
8190                 } else { assert!(false); }
8191         }
8192         // Our local monitor is in-sync and hasn't processed yet timeout
8193         check_added_monitors!(nodes[0], 1);
8194         let events = nodes[0].node.get_and_clear_pending_events();
8195         assert_eq!(events.len(), 1);
8196 }
8197
8198 #[test]
8199 fn test_concurrent_monitor_claim() {
8200         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8201         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8202         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8203         // state N+1 confirms. Alice claims output from state N+1.
8204
8205         let chanmon_cfgs = create_chanmon_cfgs(2);
8206         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8207         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8208         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8209
8210         // Create some initial channel
8211         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
8212         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8213
8214         // Rebalance the network to generate htlc in the two directions
8215         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8216
8217         // Route a HTLC from node 0 to node 1 (but don't settle)
8218         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8219
8220         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8221         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8222         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8223         let persister = test_utils::TestPersister::new();
8224         let watchtower_alice = {
8225                 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
8226                 let mut w = test_utils::TestVecWriter(Vec::new());
8227                 monitor.write(&mut w).unwrap();
8228                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8229                                 &mut io::Cursor::new(&w.0), (nodes[0].keys_manager, nodes[0].keys_manager)).unwrap().1;
8230                 assert!(new_monitor == *monitor);
8231                 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);
8232                 assert_eq!(watchtower.watch_channel(outpoint, new_monitor), ChannelMonitorUpdateStatus::Completed);
8233                 watchtower
8234         };
8235         let header = BlockHeader { version: 0x20000000, prev_blockhash: BlockHash::all_zeros(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
8236         let block = Block { header, txdata: vec![] };
8237         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8238         // transaction lock time requirements here.
8239         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (block.clone(), 0));
8240         watchtower_alice.chain_monitor.block_connected(&block, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8241
8242         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8243         {
8244                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8245                 assert_eq!(txn.len(), 2);
8246                 txn.clear();
8247         }
8248
8249         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8250         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8251         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8252         let persister = test_utils::TestPersister::new();
8253         let watchtower_bob = {
8254                 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
8255                 let mut w = test_utils::TestVecWriter(Vec::new());
8256                 monitor.write(&mut w).unwrap();
8257                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8258                                 &mut io::Cursor::new(&w.0), (nodes[0].keys_manager, nodes[0].keys_manager)).unwrap().1;
8259                 assert!(new_monitor == *monitor);
8260                 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);
8261                 assert_eq!(watchtower.watch_channel(outpoint, new_monitor), ChannelMonitorUpdateStatus::Completed);
8262                 watchtower
8263         };
8264         let header = BlockHeader { version: 0x20000000, prev_blockhash: BlockHash::all_zeros(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
8265         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8266
8267         // Route another payment to generate another update with still previous HTLC pending
8268         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 3000000);
8269         {
8270                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
8271         }
8272         check_added_monitors!(nodes[1], 1);
8273
8274         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8275         assert_eq!(updates.update_add_htlcs.len(), 1);
8276         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8277         {
8278                 let mut node_0_per_peer_lock;
8279                 let mut node_0_peer_state_lock;
8280                 let mut channel = get_channel_ref!(nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, chan_1.2);
8281                 if let Ok(update) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8282                         // Watchtower Alice should already have seen the block and reject the update
8283                         assert_eq!(watchtower_alice.chain_monitor.update_channel(outpoint, &update), ChannelMonitorUpdateStatus::PermanentFailure);
8284                         assert_eq!(watchtower_bob.chain_monitor.update_channel(outpoint, &update), ChannelMonitorUpdateStatus::Completed);
8285                         assert_eq!(nodes[0].chain_monitor.update_channel(outpoint, &update), ChannelMonitorUpdateStatus::Completed);
8286                 } else { assert!(false); }
8287         }
8288         // Our local monitor is in-sync and hasn't processed yet timeout
8289         check_added_monitors!(nodes[0], 1);
8290
8291         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8292         let header = BlockHeader { version: 0x20000000, prev_blockhash: BlockHash::all_zeros(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
8293         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8294
8295         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8296         let bob_state_y;
8297         {
8298                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8299                 assert_eq!(txn.len(), 2);
8300                 bob_state_y = txn[0].clone();
8301                 txn.clear();
8302         };
8303
8304         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8305         let header = BlockHeader { version: 0x20000000, prev_blockhash: BlockHash::all_zeros(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
8306         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);
8307         {
8308                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8309                 assert_eq!(htlc_txn.len(), 1);
8310                 check_spends!(htlc_txn[0], bob_state_y);
8311         }
8312 }
8313
8314 #[test]
8315 fn test_pre_lockin_no_chan_closed_update() {
8316         // Test that if a peer closes a channel in response to a funding_created message we don't
8317         // generate a channel update (as the channel cannot appear on chain without a funding_signed
8318         // message).
8319         //
8320         // Doing so would imply a channel monitor update before the initial channel monitor
8321         // registration, violating our API guarantees.
8322         //
8323         // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8324         // then opening a second channel with the same funding output as the first (which is not
8325         // rejected because the first channel does not exist in the ChannelManager) and closing it
8326         // before receiving funding_signed.
8327         let chanmon_cfgs = create_chanmon_cfgs(2);
8328         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8329         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8330         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8331
8332         // Create an initial channel
8333         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8334         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8335         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_chan_msg);
8336         let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8337         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_chan_msg);
8338
8339         // Move the first channel through the funding flow...
8340         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 42);
8341
8342         nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
8343         check_added_monitors!(nodes[0], 0);
8344
8345         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8346         let channel_id = crate::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8347         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8348         assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8349         check_closed_event!(nodes[0], 2, ClosureReason::CounterpartyForceClosed { peer_msg: "Hi".to_string() }, true);
8350 }
8351
8352 #[test]
8353 fn test_htlc_no_detection() {
8354         // This test is a mutation to underscore the detection logic bug we had
8355         // before #653. HTLC value routed is above the remaining balance, thus
8356         // inverting HTLC and `to_remote` output. HTLC will come second and
8357         // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8358         // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8359         // outputs order detection for correct spending children filtring.
8360
8361         let chanmon_cfgs = create_chanmon_cfgs(2);
8362         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8363         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8364         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8365
8366         // Create some initial channels
8367         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
8368
8369         send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8370         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8371         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8372         assert_eq!(local_txn[0].input.len(), 1);
8373         assert_eq!(local_txn[0].output.len(), 3);
8374         check_spends!(local_txn[0], chan_1.3);
8375
8376         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8377         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
8378         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8379         // We deliberately connect the local tx twice as this should provoke a failure calling
8380         // this test before #653 fix.
8381         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);
8382         check_closed_broadcast!(nodes[0], true);
8383         check_added_monitors!(nodes[0], 1);
8384         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
8385         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
8386
8387         let htlc_timeout = {
8388                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8389                 assert_eq!(node_txn.len(), 1);
8390                 assert_eq!(node_txn[0].input.len(), 1);
8391                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8392                 check_spends!(node_txn[0], local_txn[0]);
8393                 node_txn[0].clone()
8394         };
8395
8396         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
8397         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8398         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8399         expect_payment_failed!(nodes[0], our_payment_hash, false);
8400 }
8401
8402 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8403         // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8404         // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8405         // Carol, Alice would be the upstream node, and Carol the downstream.)
8406         //
8407         // Steps of the test:
8408         // 1) Alice sends a HTLC to Carol through Bob.
8409         // 2) Carol doesn't settle the HTLC.
8410         // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8411         // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8412         // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8413         //    but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8414         // 5) Carol release the preimage to Bob off-chain.
8415         // 6) Bob claims the offered output on the broadcasted commitment.
8416         let chanmon_cfgs = create_chanmon_cfgs(3);
8417         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8418         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8419         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8420
8421         // Create some initial channels
8422         let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
8423         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001);
8424
8425         // Steps (1) and (2):
8426         // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8427         let (payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3_000_000);
8428
8429         // Check that Alice's commitment transaction now contains an output for this HTLC.
8430         let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8431         check_spends!(alice_txn[0], chan_ab.3);
8432         assert_eq!(alice_txn[0].output.len(), 2);
8433         check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8434         assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8435         assert_eq!(alice_txn.len(), 2);
8436
8437         // Steps (3) and (4):
8438         // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8439         // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8440         let mut force_closing_node = 0; // Alice force-closes
8441         let mut counterparty_node = 1; // Bob if Alice force-closes
8442
8443         // Bob force-closes
8444         if !broadcast_alice {
8445                 force_closing_node = 1;
8446                 counterparty_node = 0;
8447         }
8448         nodes[force_closing_node].node.force_close_broadcasting_latest_txn(&chan_ab.2, &nodes[counterparty_node].node.get_our_node_id()).unwrap();
8449         check_closed_broadcast!(nodes[force_closing_node], true);
8450         check_added_monitors!(nodes[force_closing_node], 1);
8451         check_closed_event!(nodes[force_closing_node], 1, ClosureReason::HolderForceClosed);
8452         if go_onchain_before_fulfill {
8453                 let txn_to_broadcast = match broadcast_alice {
8454                         true => alice_txn.clone(),
8455                         false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8456                 };
8457                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42};
8458                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8459                 if broadcast_alice {
8460                         check_closed_broadcast!(nodes[1], true);
8461                         check_added_monitors!(nodes[1], 1);
8462                         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
8463                 }
8464         }
8465
8466         // Step (5):
8467         // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8468         // process of removing the HTLC from their commitment transactions.
8469         nodes[2].node.claim_funds(payment_preimage);
8470         check_added_monitors!(nodes[2], 1);
8471         expect_payment_claimed!(nodes[2], payment_hash, 3_000_000);
8472
8473         let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8474         assert!(carol_updates.update_add_htlcs.is_empty());
8475         assert!(carol_updates.update_fail_htlcs.is_empty());
8476         assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8477         assert!(carol_updates.update_fee.is_none());
8478         assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8479
8480         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8481         expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false, false);
8482         // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8483         if !go_onchain_before_fulfill && broadcast_alice {
8484                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8485                 assert_eq!(events.len(), 1);
8486                 match events[0] {
8487                         MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8488                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8489                         },
8490                         _ => panic!("Unexpected event"),
8491                 };
8492         }
8493         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8494         // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8495         // Carol<->Bob's updated commitment transaction info.
8496         check_added_monitors!(nodes[1], 2);
8497
8498         let events = nodes[1].node.get_and_clear_pending_msg_events();
8499         assert_eq!(events.len(), 2);
8500         let bob_revocation = match events[0] {
8501                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8502                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8503                         (*msg).clone()
8504                 },
8505                 _ => panic!("Unexpected event"),
8506         };
8507         let bob_updates = match events[1] {
8508                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8509                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8510                         (*updates).clone()
8511                 },
8512                 _ => panic!("Unexpected event"),
8513         };
8514
8515         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8516         check_added_monitors!(nodes[2], 1);
8517         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8518         check_added_monitors!(nodes[2], 1);
8519
8520         let events = nodes[2].node.get_and_clear_pending_msg_events();
8521         assert_eq!(events.len(), 1);
8522         let carol_revocation = match events[0] {
8523                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8524                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8525                         (*msg).clone()
8526                 },
8527                 _ => panic!("Unexpected event"),
8528         };
8529         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8530         check_added_monitors!(nodes[1], 1);
8531
8532         // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8533         // here's where we put said channel's commitment tx on-chain.
8534         let mut txn_to_broadcast = alice_txn.clone();
8535         if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8536         if !go_onchain_before_fulfill {
8537                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42};
8538                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8539                 // If Bob was the one to force-close, he will have already passed these checks earlier.
8540                 if broadcast_alice {
8541                         check_closed_broadcast!(nodes[1], true);
8542                         check_added_monitors!(nodes[1], 1);
8543                         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
8544                 }
8545                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8546                 if broadcast_alice {
8547                         assert_eq!(bob_txn.len(), 1);
8548                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
8549                 } else {
8550                         assert_eq!(bob_txn.len(), 2);
8551                         check_spends!(bob_txn[0], chan_ab.3);
8552                 }
8553         }
8554
8555         // Step (6):
8556         // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8557         // broadcasted commitment transaction.
8558         {
8559                 let script_weight = match broadcast_alice {
8560                         true => OFFERED_HTLC_SCRIPT_WEIGHT,
8561                         false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8562                 };
8563                 // If Alice force-closed, Bob only broadcasts a HTLC-output-claiming transaction. Otherwise,
8564                 // Bob force-closed and broadcasts the commitment transaction along with a
8565                 // HTLC-output-claiming transaction.
8566                 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8567                 if broadcast_alice {
8568                         assert_eq!(bob_txn.len(), 1);
8569                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
8570                         assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
8571                 } else {
8572                         assert_eq!(bob_txn.len(), 2);
8573                         check_spends!(bob_txn[1], txn_to_broadcast[0]);
8574                         assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
8575                 }
8576         }
8577 }
8578
8579 #[test]
8580 fn test_onchain_htlc_settlement_after_close() {
8581         do_test_onchain_htlc_settlement_after_close(true, true);
8582         do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
8583         do_test_onchain_htlc_settlement_after_close(true, false);
8584         do_test_onchain_htlc_settlement_after_close(false, false);
8585 }
8586
8587 #[test]
8588 fn test_duplicate_temporary_channel_id_from_different_peers() {
8589         // Tests that we can accept two different `OpenChannel` requests with the same
8590         // `temporary_channel_id`, as long as they are from different peers.
8591         let chanmon_cfgs = create_chanmon_cfgs(3);
8592         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8593         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8594         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8595
8596         // Create an first channel channel
8597         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8598         let mut open_chan_msg_chan_1_0 = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
8599
8600         // Create an second channel
8601         nodes[2].node.create_channel(nodes[0].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
8602         let mut open_chan_msg_chan_2_0 = get_event_msg!(nodes[2], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
8603
8604         // Modify the `OpenChannel` from `nodes[2]` to `nodes[0]` to ensure that it uses the same
8605         // `temporary_channel_id` as the `OpenChannel` from nodes[1] to nodes[0].
8606         open_chan_msg_chan_2_0.temporary_channel_id = open_chan_msg_chan_1_0.temporary_channel_id;
8607
8608         // Assert that `nodes[0]` can accept both `OpenChannel` requests, even though they use the same
8609         // `temporary_channel_id` as they are from different peers.
8610         nodes[0].node.handle_open_channel(&nodes[1].node.get_our_node_id(), &open_chan_msg_chan_1_0);
8611         {
8612                 let events = nodes[0].node.get_and_clear_pending_msg_events();
8613                 assert_eq!(events.len(), 1);
8614                 match &events[0] {
8615                         MessageSendEvent::SendAcceptChannel { node_id, msg } => {
8616                                 assert_eq!(node_id, &nodes[1].node.get_our_node_id());
8617                                 assert_eq!(msg.temporary_channel_id, open_chan_msg_chan_1_0.temporary_channel_id);
8618                         },
8619                         _ => panic!("Unexpected event"),
8620                 }
8621         }
8622
8623         nodes[0].node.handle_open_channel(&nodes[2].node.get_our_node_id(), &open_chan_msg_chan_2_0);
8624         {
8625                 let events = nodes[0].node.get_and_clear_pending_msg_events();
8626                 assert_eq!(events.len(), 1);
8627                 match &events[0] {
8628                         MessageSendEvent::SendAcceptChannel { node_id, msg } => {
8629                                 assert_eq!(node_id, &nodes[2].node.get_our_node_id());
8630                                 assert_eq!(msg.temporary_channel_id, open_chan_msg_chan_1_0.temporary_channel_id);
8631                         },
8632                         _ => panic!("Unexpected event"),
8633                 }
8634         }
8635 }
8636
8637 #[test]
8638 fn test_duplicate_chan_id() {
8639         // Test that if a given peer tries to open a channel with the same channel_id as one that is
8640         // already open we reject it and keep the old channel.
8641         //
8642         // Previously, full_stack_target managed to figure out that if you tried to open two channels
8643         // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
8644         // the existing channel when we detect the duplicate new channel, screwing up our monitor
8645         // updating logic for the existing channel.
8646         let chanmon_cfgs = create_chanmon_cfgs(2);
8647         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8648         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8649         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8650
8651         // Create an initial channel
8652         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8653         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8654         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_chan_msg);
8655         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
8656
8657         // Try to create a second channel with the same temporary_channel_id as the first and check
8658         // that it is rejected.
8659         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_chan_msg);
8660         {
8661                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8662                 assert_eq!(events.len(), 1);
8663                 match events[0] {
8664                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8665                                 // Technically, at this point, nodes[1] would be justified in thinking both the
8666                                 // first (valid) and second (invalid) channels are closed, given they both have
8667                                 // the same non-temporary channel_id. However, currently we do not, so we just
8668                                 // move forward with it.
8669                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8670                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8671                         },
8672                         _ => panic!("Unexpected event"),
8673                 }
8674         }
8675
8676         // Move the first channel through the funding flow...
8677         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 42);
8678
8679         nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
8680         check_added_monitors!(nodes[0], 0);
8681
8682         let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8683         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8684         {
8685                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
8686                 assert_eq!(added_monitors.len(), 1);
8687                 assert_eq!(added_monitors[0].0, funding_output);
8688                 added_monitors.clear();
8689         }
8690         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8691
8692         let funding_outpoint = crate::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
8693         let channel_id = funding_outpoint.to_channel_id();
8694
8695         // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
8696         // temporary one).
8697
8698         // First try to open a second channel with a temporary channel id equal to the txid-based one.
8699         // Technically this is allowed by the spec, but we don't support it and there's little reason
8700         // to. Still, it shouldn't cause any other issues.
8701         open_chan_msg.temporary_channel_id = channel_id;
8702         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_chan_msg);
8703         {
8704                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8705                 assert_eq!(events.len(), 1);
8706                 match events[0] {
8707                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8708                                 // Technically, at this point, nodes[1] would be justified in thinking both
8709                                 // channels are closed, but currently we do not, so we just move forward with it.
8710                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8711                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8712                         },
8713                         _ => panic!("Unexpected event"),
8714                 }
8715         }
8716
8717         // Now try to create a second channel which has a duplicate funding output.
8718         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8719         let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8720         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_chan_2_msg);
8721         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
8722         create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 42); // Get and check the FundingGenerationReady event
8723
8724         let funding_created = {
8725                 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
8726                 let mut a_peer_state = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
8727                 // Once we call `get_outbound_funding_created` the channel has a duplicate channel_id as
8728                 // another channel in the ChannelManager - an invalid state. Thus, we'd panic later when we
8729                 // try to create another channel. Instead, we drop the channel entirely here (leaving the
8730                 // channelmanager in a possibly nonsense state instead).
8731                 let mut as_chan = a_peer_state.channel_by_id.remove(&open_chan_2_msg.temporary_channel_id).unwrap();
8732                 let logger = test_utils::TestLogger::new();
8733                 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
8734         };
8735         check_added_monitors!(nodes[0], 0);
8736         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
8737         // At this point we'll look up if the channel_id is present and immediately fail the channel
8738         // without trying to persist the `ChannelMonitor`.
8739         check_added_monitors!(nodes[1], 0);
8740
8741         // ...still, nodes[1] will reject the duplicate channel.
8742         {
8743                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8744                 assert_eq!(events.len(), 1);
8745                 match events[0] {
8746                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8747                                 // Technically, at this point, nodes[1] would be justified in thinking both
8748                                 // channels are closed, but currently we do not, so we just move forward with it.
8749                                 assert_eq!(msg.channel_id, channel_id);
8750                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8751                         },
8752                         _ => panic!("Unexpected event"),
8753                 }
8754         }
8755
8756         // finally, finish creating the original channel and send a payment over it to make sure
8757         // everything is functional.
8758         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
8759         {
8760                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
8761                 assert_eq!(added_monitors.len(), 1);
8762                 assert_eq!(added_monitors[0].0, funding_output);
8763                 added_monitors.clear();
8764         }
8765
8766         let events_4 = nodes[0].node.get_and_clear_pending_events();
8767         assert_eq!(events_4.len(), 0);
8768         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
8769         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
8770
8771         let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8772         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
8773         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
8774
8775         send_payment(&nodes[0], &[&nodes[1]], 8000000);
8776 }
8777
8778 #[test]
8779 fn test_error_chans_closed() {
8780         // Test that we properly handle error messages, closing appropriate channels.
8781         //
8782         // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
8783         // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
8784         // we can test various edge cases around it to ensure we don't regress.
8785         let chanmon_cfgs = create_chanmon_cfgs(3);
8786         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8787         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8788         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8789
8790         // Create some initial channels
8791         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
8792         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
8793         let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
8794
8795         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8796         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
8797         assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
8798
8799         // Closing a channel from a different peer has no effect
8800         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
8801         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8802
8803         // Closing one channel doesn't impact others
8804         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
8805         check_added_monitors!(nodes[0], 1);
8806         check_closed_broadcast!(nodes[0], false);
8807         check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyForceClosed { peer_msg: "ERR".to_string() });
8808         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
8809         assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
8810         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);
8811         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);
8812
8813         // A null channel ID should close all channels
8814         let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
8815         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
8816         check_added_monitors!(nodes[0], 2);
8817         check_closed_event!(nodes[0], 2, ClosureReason::CounterpartyForceClosed { peer_msg: "ERR".to_string() });
8818         let events = nodes[0].node.get_and_clear_pending_msg_events();
8819         assert_eq!(events.len(), 2);
8820         match events[0] {
8821                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8822                         assert_eq!(msg.contents.flags & 2, 2);
8823                 },
8824                 _ => panic!("Unexpected event"),
8825         }
8826         match events[1] {
8827                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8828                         assert_eq!(msg.contents.flags & 2, 2);
8829                 },
8830                 _ => panic!("Unexpected event"),
8831         }
8832         // Note that at this point users of a standard PeerHandler will end up calling
8833         // peer_disconnected.
8834         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8835         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8836
8837         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
8838         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8839         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8840 }
8841
8842 #[test]
8843 fn test_invalid_funding_tx() {
8844         // Test that we properly handle invalid funding transactions sent to us from a peer.
8845         //
8846         // Previously, all other major lightning implementations had failed to properly sanitize
8847         // funding transactions from their counterparties, leading to a multi-implementation critical
8848         // security vulnerability (though we always sanitized properly, we've previously had
8849         // un-released crashes in the sanitization process).
8850         //
8851         // Further, if the funding transaction is consensus-valid, confirms, and is later spent, we'd
8852         // previously have crashed in `ChannelMonitor` even though we closed the channel as bogus and
8853         // gave up on it. We test this here by generating such a transaction.
8854         let chanmon_cfgs = create_chanmon_cfgs(2);
8855         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8856         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8857         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8858
8859         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
8860         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
8861         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
8862
8863         let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100_000, 42);
8864
8865         // Create a witness program which can be spent by a 4-empty-stack-elements witness and which is
8866         // 136 bytes long. This matches our "accepted HTLC preimage spend" matching, previously causing
8867         // a panic as we'd try to extract a 32 byte preimage from a witness element without checking
8868         // its length.
8869         let mut wit_program: Vec<u8> = channelmonitor::deliberately_bogus_accepted_htlc_witness_program();
8870         let wit_program_script: Script = wit_program.into();
8871         for output in tx.output.iter_mut() {
8872                 // Make the confirmed funding transaction have a bogus script_pubkey
8873                 output.script_pubkey = Script::new_v0_p2wsh(&wit_program_script.wscript_hash());
8874         }
8875
8876         nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone(), 0).unwrap();
8877         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()));
8878         check_added_monitors!(nodes[1], 1);
8879
8880         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()));
8881         check_added_monitors!(nodes[0], 1);
8882
8883         let events_1 = nodes[0].node.get_and_clear_pending_events();
8884         assert_eq!(events_1.len(), 0);
8885
8886         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
8887         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
8888         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
8889
8890         let expected_err = "funding tx had wrong script/value or output index";
8891         confirm_transaction_at(&nodes[1], &tx, 1);
8892         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: expected_err.to_string() });
8893         check_added_monitors!(nodes[1], 1);
8894         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
8895         assert_eq!(events_2.len(), 1);
8896         if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
8897                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8898                 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
8899                         assert_eq!(msg.data, "Channel closed because of an exception: ".to_owned() + expected_err);
8900                 } else { panic!(); }
8901         } else { panic!(); }
8902         assert_eq!(nodes[1].node.list_channels().len(), 0);
8903
8904         // Now confirm a spend of the (bogus) funding transaction. As long as the witness is 5 elements
8905         // long the ChannelMonitor will try to read 32 bytes from the second-to-last element, panicing
8906         // as its not 32 bytes long.
8907         let mut spend_tx = Transaction {
8908                 version: 2i32, lock_time: PackedLockTime::ZERO,
8909                 input: tx.output.iter().enumerate().map(|(idx, _)| TxIn {
8910                         previous_output: BitcoinOutPoint {
8911                                 txid: tx.txid(),
8912                                 vout: idx as u32,
8913                         },
8914                         script_sig: Script::new(),
8915                         sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
8916                         witness: Witness::from_vec(channelmonitor::deliberately_bogus_accepted_htlc_witness())
8917                 }).collect(),
8918                 output: vec![TxOut {
8919                         value: 1000,
8920                         script_pubkey: Script::new(),
8921                 }]
8922         };
8923         check_spends!(spend_tx, tx);
8924         mine_transaction(&nodes[1], &spend_tx);
8925 }
8926
8927 fn do_test_tx_confirmed_skipping_blocks_immediate_broadcast(test_height_before_timelock: bool) {
8928         // In the first version of the chain::Confirm interface, after a refactor was made to not
8929         // broadcast CSV-locked transactions until their CSV lock is up, we wouldn't reliably broadcast
8930         // transactions after a `transactions_confirmed` call. Specifically, if the chain, provided via
8931         // `best_block_updated` is at height N, and a transaction output which we wish to spend at
8932         // height N-1 (due to a CSV to height N-1) is provided at height N, we will not broadcast the
8933         // spending transaction until height N+1 (or greater). This was due to the way
8934         // `ChannelMonitor::transactions_confirmed` worked, only checking if we should broadcast a
8935         // spending transaction at the height the input transaction was confirmed at, not whether we
8936         // should broadcast a spending transaction at the current height.
8937         // A second, similar, issue involved failing HTLCs backwards - because we only provided the
8938         // height at which transactions were confirmed to `OnchainTx::update_claims_view`, it wasn't
8939         // aware that the anti-reorg-delay had, in fact, already expired, waiting to fail-backwards
8940         // until we learned about an additional block.
8941         //
8942         // As an additional check, if `test_height_before_timelock` is set, we instead test that we
8943         // aren't broadcasting transactions too early (ie not broadcasting them at all).
8944         let chanmon_cfgs = create_chanmon_cfgs(3);
8945         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8946         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8947         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8948         *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
8949
8950         create_announced_chan_between_nodes(&nodes, 0, 1);
8951         let (chan_announce, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 1, 2);
8952         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
8953         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id());
8954         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
8955
8956         nodes[1].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[2].node.get_our_node_id()).unwrap();
8957         check_closed_broadcast!(nodes[1], true);
8958         check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
8959         check_added_monitors!(nodes[1], 1);
8960         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
8961         assert_eq!(node_txn.len(), 1);
8962
8963         let conf_height = nodes[1].best_block_info().1;
8964         if !test_height_before_timelock {
8965                 connect_blocks(&nodes[1], 24 * 6);
8966         }
8967         nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
8968                 &nodes[1].get_block_header(conf_height), &[(0, &node_txn[0])], conf_height);
8969         if test_height_before_timelock {
8970                 // If we confirmed the close transaction, but timelocks have not yet expired, we should not
8971                 // generate any events or broadcast any transactions
8972                 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8973                 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
8974         } else {
8975                 // We should broadcast an HTLC transaction spending our funding transaction first
8976                 let spending_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
8977                 assert_eq!(spending_txn.len(), 2);
8978                 assert_eq!(spending_txn[0], node_txn[0]);
8979                 check_spends!(spending_txn[1], node_txn[0]);
8980                 // We should also generate a SpendableOutputs event with the to_self output (as its
8981                 // timelock is up).
8982                 let descriptor_spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
8983                 assert_eq!(descriptor_spend_txn.len(), 1);
8984
8985                 // If we also discover that the HTLC-Timeout transaction was confirmed some time ago, we
8986                 // should immediately fail-backwards the HTLC to the previous hop, without waiting for an
8987                 // additional block built on top of the current chain.
8988                 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
8989                         &nodes[1].get_block_header(conf_height + 1), &[(0, &spending_txn[1])], conf_height + 1);
8990                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: channel_id }]);
8991                 check_added_monitors!(nodes[1], 1);
8992
8993                 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8994                 assert!(updates.update_add_htlcs.is_empty());
8995                 assert!(updates.update_fulfill_htlcs.is_empty());
8996                 assert_eq!(updates.update_fail_htlcs.len(), 1);
8997                 assert!(updates.update_fail_malformed_htlcs.is_empty());
8998                 assert!(updates.update_fee.is_none());
8999                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9000                 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9001                 expect_payment_failed_with_update!(nodes[0], payment_hash, false, chan_announce.contents.short_channel_id, true);
9002         }
9003 }
9004
9005 #[test]
9006 fn test_tx_confirmed_skipping_blocks_immediate_broadcast() {
9007         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(false);
9008         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(true);
9009 }
9010
9011 fn do_test_dup_htlc_second_rejected(test_for_second_fail_panic: bool) {
9012         let chanmon_cfgs = create_chanmon_cfgs(2);
9013         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9014         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9015         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9016
9017         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
9018
9019         let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
9020                 .with_features(nodes[1].node.invoice_features());
9021         let route = get_route!(nodes[0], payment_params, 10_000, TEST_FINAL_CLTV).unwrap();
9022
9023         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(&nodes[1]);
9024
9025         {
9026                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
9027                 check_added_monitors!(nodes[0], 1);
9028                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9029                 assert_eq!(events.len(), 1);
9030                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
9031                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9032                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9033         }
9034         expect_pending_htlcs_forwardable!(nodes[1]);
9035         expect_payment_claimable!(nodes[1], our_payment_hash, our_payment_secret, 10_000);
9036
9037         {
9038                 // Note that we use a different PaymentId here to allow us to duplicativly pay
9039                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_secret.0)).unwrap();
9040                 check_added_monitors!(nodes[0], 1);
9041                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9042                 assert_eq!(events.len(), 1);
9043                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
9044                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9045                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9046                 // At this point, nodes[1] would notice it has too much value for the payment. It will
9047                 // assume the second is a privacy attack (no longer particularly relevant
9048                 // post-payment_secrets) and fail back the new HTLC. Previously, it'd also have failed back
9049                 // the first HTLC delivered above.
9050         }
9051
9052         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
9053         nodes[1].node.process_pending_htlc_forwards();
9054
9055         if test_for_second_fail_panic {
9056                 // Now we go fail back the first HTLC from the user end.
9057                 nodes[1].node.fail_htlc_backwards(&our_payment_hash);
9058
9059                 let expected_destinations = vec![
9060                         HTLCDestination::FailedPayment { payment_hash: our_payment_hash },
9061                         HTLCDestination::FailedPayment { payment_hash: our_payment_hash },
9062                 ];
9063                 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1],  expected_destinations);
9064                 nodes[1].node.process_pending_htlc_forwards();
9065
9066                 check_added_monitors!(nodes[1], 1);
9067                 let fail_updates_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9068                 assert_eq!(fail_updates_1.update_fail_htlcs.len(), 2);
9069
9070                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_updates_1.update_fail_htlcs[0]);
9071                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_updates_1.update_fail_htlcs[1]);
9072                 commitment_signed_dance!(nodes[0], nodes[1], fail_updates_1.commitment_signed, false);
9073
9074                 let failure_events = nodes[0].node.get_and_clear_pending_events();
9075                 assert_eq!(failure_events.len(), 4);
9076                 if let Event::PaymentPathFailed { .. } = failure_events[0] {} else { panic!(); }
9077                 if let Event::PaymentFailed { .. } = failure_events[1] {} else { panic!(); }
9078                 if let Event::PaymentPathFailed { .. } = failure_events[2] {} else { panic!(); }
9079                 if let Event::PaymentFailed { .. } = failure_events[3] {} else { panic!(); }
9080         } else {
9081                 // Let the second HTLC fail and claim the first
9082                 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
9083                 nodes[1].node.process_pending_htlc_forwards();
9084
9085                 check_added_monitors!(nodes[1], 1);
9086                 let fail_updates_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9087                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_updates_1.update_fail_htlcs[0]);
9088                 commitment_signed_dance!(nodes[0], nodes[1], fail_updates_1.commitment_signed, false);
9089
9090                 expect_payment_failed_conditions(&nodes[0], our_payment_hash, true, PaymentFailedConditions::new());
9091
9092                 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
9093         }
9094 }
9095
9096 #[test]
9097 fn test_dup_htlc_second_fail_panic() {
9098         // Previously, if we received two HTLCs back-to-back, where the second overran the expected
9099         // value for the payment, we'd fail back both HTLCs after generating a `PaymentClaimable` event.
9100         // Then, if the user failed the second payment, they'd hit a "tried to fail an already failed
9101         // HTLC" debug panic. This tests for this behavior, checking that only one HTLC is auto-failed.
9102         do_test_dup_htlc_second_rejected(true);
9103 }
9104
9105 #[test]
9106 fn test_dup_htlc_second_rejected() {
9107         // Test that if we receive a second HTLC for an MPP payment that overruns the payment amount we
9108         // simply reject the second HTLC but are still able to claim the first HTLC.
9109         do_test_dup_htlc_second_rejected(false);
9110 }
9111
9112 #[test]
9113 fn test_inconsistent_mpp_params() {
9114         // Test that if we recieve two HTLCs with different payment parameters we fail back the first
9115         // such HTLC and allow the second to stay.
9116         let chanmon_cfgs = create_chanmon_cfgs(4);
9117         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
9118         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
9119         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
9120
9121         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 0);
9122         create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100_000, 0);
9123         create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 100_000, 0);
9124         let chan_2_3 =create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 100_000, 0);
9125
9126         let payment_params = PaymentParameters::from_node_id(nodes[3].node.get_our_node_id(), TEST_FINAL_CLTV)
9127                 .with_features(nodes[3].node.invoice_features());
9128         let mut route = get_route!(nodes[0], payment_params, 15_000_000, TEST_FINAL_CLTV).unwrap();
9129         assert_eq!(route.paths.len(), 2);
9130         route.paths.sort_by(|path_a, _| {
9131                 // Sort the path so that the path through nodes[1] comes first
9132                 if path_a[0].pubkey == nodes[1].node.get_our_node_id() {
9133                         core::cmp::Ordering::Less } else { core::cmp::Ordering::Greater }
9134         });
9135         let payment_params_opt = Some(payment_params);
9136
9137         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(&nodes[3]);
9138
9139         let cur_height = nodes[0].best_block_info().1;
9140         let payment_id = PaymentId([42; 32]);
9141
9142         let session_privs = {
9143                 // We create a fake route here so that we start with three pending HTLCs, which we'll
9144                 // ultimately have, just not right away.
9145                 let mut dup_route = route.clone();
9146                 dup_route.paths.push(route.paths[1].clone());
9147                 nodes[0].node.test_add_new_pending_payment(our_payment_hash, Some(our_payment_secret), payment_id, &dup_route).unwrap()
9148         };
9149         {
9150                 nodes[0].node.send_payment_along_path(&route.paths[0], &payment_params_opt, &our_payment_hash, &Some(our_payment_secret), 15_000_000, cur_height, payment_id, &None, session_privs[0]).unwrap();
9151                 check_added_monitors!(nodes[0], 1);
9152
9153                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9154                 assert_eq!(events.len(), 1);
9155                 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 15_000_000, our_payment_hash, Some(our_payment_secret), events.pop().unwrap(), false, None);
9156         }
9157         assert!(nodes[3].node.get_and_clear_pending_events().is_empty());
9158
9159         {
9160                 nodes[0].node.send_payment_along_path(&route.paths[1], &payment_params_opt, &our_payment_hash, &Some(our_payment_secret), 14_000_000, cur_height, payment_id, &None, session_privs[1]).unwrap();
9161                 check_added_monitors!(nodes[0], 1);
9162
9163                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9164                 assert_eq!(events.len(), 1);
9165                 let payment_event = SendEvent::from_event(events.pop().unwrap());
9166
9167                 nodes[2].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9168                 commitment_signed_dance!(nodes[2], nodes[0], payment_event.commitment_msg, false);
9169
9170                 expect_pending_htlcs_forwardable!(nodes[2]);
9171                 check_added_monitors!(nodes[2], 1);
9172
9173                 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
9174                 assert_eq!(events.len(), 1);
9175                 let payment_event = SendEvent::from_event(events.pop().unwrap());
9176
9177                 nodes[3].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
9178                 check_added_monitors!(nodes[3], 0);
9179                 commitment_signed_dance!(nodes[3], nodes[2], payment_event.commitment_msg, true, true);
9180
9181                 // At this point, nodes[3] should notice the two HTLCs don't contain the same total payment
9182                 // amount. It will assume the second is a privacy attack (no longer particularly relevant
9183                 // post-payment_secrets) and fail back the new HTLC.
9184         }
9185         expect_pending_htlcs_forwardable_ignore!(nodes[3]);
9186         nodes[3].node.process_pending_htlc_forwards();
9187         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[3], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
9188         nodes[3].node.process_pending_htlc_forwards();
9189
9190         check_added_monitors!(nodes[3], 1);
9191
9192         let fail_updates_1 = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
9193         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &fail_updates_1.update_fail_htlcs[0]);
9194         commitment_signed_dance!(nodes[2], nodes[3], fail_updates_1.commitment_signed, false);
9195
9196         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_2_3.2 }]);
9197         check_added_monitors!(nodes[2], 1);
9198
9199         let fail_updates_2 = get_htlc_update_msgs!(nodes[2], nodes[0].node.get_our_node_id());
9200         nodes[0].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_updates_2.update_fail_htlcs[0]);
9201         commitment_signed_dance!(nodes[0], nodes[2], fail_updates_2.commitment_signed, false);
9202
9203         expect_payment_failed_conditions(&nodes[0], our_payment_hash, true, PaymentFailedConditions::new().mpp_parts_remain());
9204
9205         nodes[0].node.send_payment_along_path(&route.paths[1], &payment_params_opt, &our_payment_hash, &Some(our_payment_secret), 15_000_000, cur_height, payment_id, &None, session_privs[2]).unwrap();
9206         check_added_monitors!(nodes[0], 1);
9207
9208         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9209         assert_eq!(events.len(), 1);
9210         pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 15_000_000, our_payment_hash, Some(our_payment_secret), events.pop().unwrap(), true, None);
9211
9212         do_claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, our_payment_preimage);
9213         let events = nodes[0].node.get_and_clear_pending_events();
9214         assert_eq!(events.len(), 3);
9215         match events[0] {
9216                 Event::PaymentSent { payment_hash, .. } => { // The payment was abandoned earlier, so the fee paid will be None
9217                         assert_eq!(payment_hash, our_payment_hash);
9218                 },
9219                 _ => panic!("Unexpected event")
9220         }
9221         match events[1] {
9222                 Event::PaymentPathSuccessful { payment_hash, .. } => {
9223                         assert_eq!(payment_hash.unwrap(), our_payment_hash);
9224                 },
9225                 _ => panic!("Unexpected event")
9226         }
9227         match events[2] {
9228                 Event::PaymentPathSuccessful { payment_hash, .. } => {
9229                         assert_eq!(payment_hash.unwrap(), our_payment_hash);
9230                 },
9231                 _ => panic!("Unexpected event")
9232         }
9233 }
9234
9235 #[test]
9236 fn test_keysend_payments_to_public_node() {
9237         let chanmon_cfgs = create_chanmon_cfgs(2);
9238         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9239         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9240         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9241
9242         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
9243         let network_graph = nodes[0].network_graph.clone();
9244         let payer_pubkey = nodes[0].node.get_our_node_id();
9245         let payee_pubkey = nodes[1].node.get_our_node_id();
9246         let route_params = RouteParameters {
9247                 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
9248                 final_value_msat: 10000,
9249                 final_cltv_expiry_delta: 40,
9250         };
9251         let scorer = test_utils::TestScorer::new();
9252         let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
9253         let route = find_route(&payer_pubkey, &route_params, &network_graph, None, nodes[0].logger, &scorer, &random_seed_bytes).unwrap();
9254
9255         let test_preimage = PaymentPreimage([42; 32]);
9256         let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage), PaymentId(test_preimage.0)).unwrap();
9257         check_added_monitors!(nodes[0], 1);
9258         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9259         assert_eq!(events.len(), 1);
9260         let event = events.pop().unwrap();
9261         let path = vec![&nodes[1]];
9262         pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9263         claim_payment(&nodes[0], &path, test_preimage);
9264 }
9265
9266 #[test]
9267 fn test_keysend_payments_to_private_node() {
9268         let chanmon_cfgs = create_chanmon_cfgs(2);
9269         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9270         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9271         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9272
9273         let payer_pubkey = nodes[0].node.get_our_node_id();
9274         let payee_pubkey = nodes[1].node.get_our_node_id();
9275
9276         let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
9277         let route_params = RouteParameters {
9278                 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
9279                 final_value_msat: 10000,
9280                 final_cltv_expiry_delta: 40,
9281         };
9282         let network_graph = nodes[0].network_graph.clone();
9283         let first_hops = nodes[0].node.list_usable_channels();
9284         let scorer = test_utils::TestScorer::new();
9285         let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
9286         let route = find_route(
9287                 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
9288                 nodes[0].logger, &scorer, &random_seed_bytes
9289         ).unwrap();
9290
9291         let test_preimage = PaymentPreimage([42; 32]);
9292         let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage), PaymentId(test_preimage.0)).unwrap();
9293         check_added_monitors!(nodes[0], 1);
9294         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9295         assert_eq!(events.len(), 1);
9296         let event = events.pop().unwrap();
9297         let path = vec![&nodes[1]];
9298         pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9299         claim_payment(&nodes[0], &path, test_preimage);
9300 }
9301
9302 #[test]
9303 fn test_double_partial_claim() {
9304         // Test what happens if a node receives a payment, generates a PaymentClaimable event, the HTLCs
9305         // time out, the sender resends only some of the MPP parts, then the user processes the
9306         // PaymentClaimable event, ensuring they don't inadvertently claim only part of the full payment
9307         // amount.
9308         let chanmon_cfgs = create_chanmon_cfgs(4);
9309         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
9310         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
9311         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
9312
9313         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 0);
9314         create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100_000, 0);
9315         create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 100_000, 0);
9316         create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 100_000, 0);
9317
9318         let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[3], 15_000_000);
9319         assert_eq!(route.paths.len(), 2);
9320         route.paths.sort_by(|path_a, _| {
9321                 // Sort the path so that the path through nodes[1] comes first
9322                 if path_a[0].pubkey == nodes[1].node.get_our_node_id() {
9323                         core::cmp::Ordering::Less } else { core::cmp::Ordering::Greater }
9324         });
9325
9326         send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 15_000_000, payment_hash, payment_secret);
9327         // nodes[3] has now received a PaymentClaimable event...which it will take some (exorbitant)
9328         // amount of time to respond to.
9329
9330         // Connect some blocks to time out the payment
9331         connect_blocks(&nodes[3], TEST_FINAL_CLTV);
9332         connect_blocks(&nodes[0], TEST_FINAL_CLTV); // To get the same height for sending later
9333
9334         let failed_destinations = vec![
9335                 HTLCDestination::FailedPayment { payment_hash },
9336                 HTLCDestination::FailedPayment { payment_hash },
9337         ];
9338         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[3], failed_destinations);
9339
9340         pass_failed_payment_back(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash);
9341
9342         // nodes[1] now retries one of the two paths...
9343         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
9344         check_added_monitors!(nodes[0], 2);
9345
9346         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9347         assert_eq!(events.len(), 2);
9348         let node_1_msgs = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
9349         pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 15_000_000, payment_hash, Some(payment_secret), node_1_msgs, false, None);
9350
9351         // At this point nodes[3] has received one half of the payment, and the user goes to handle
9352         // that PaymentClaimable event they got hours ago and never handled...we should refuse to claim.
9353         nodes[3].node.claim_funds(payment_preimage);
9354         check_added_monitors!(nodes[3], 0);
9355         assert!(nodes[3].node.get_and_clear_pending_msg_events().is_empty());
9356 }
9357
9358 /// The possible events which may trigger a `max_dust_htlc_exposure` breach
9359 #[derive(Clone, Copy, PartialEq)]
9360 enum ExposureEvent {
9361         /// Breach occurs at HTLC forwarding (see `send_htlc`)
9362         AtHTLCForward,
9363         /// Breach occurs at HTLC reception (see `update_add_htlc`)
9364         AtHTLCReception,
9365         /// Breach occurs at outbound update_fee (see `send_update_fee`)
9366         AtUpdateFeeOutbound,
9367 }
9368
9369 fn do_test_max_dust_htlc_exposure(dust_outbound_balance: bool, exposure_breach_event: ExposureEvent, on_holder_tx: bool) {
9370         // Test that we properly reject dust HTLC violating our `max_dust_htlc_exposure_msat`
9371         // policy.
9372         //
9373         // At HTLC forward (`send_payment()`), if the sum of the trimmed-to-dust HTLC inbound and
9374         // trimmed-to-dust HTLC outbound balance and this new payment as included on next
9375         // counterparty commitment are above our `max_dust_htlc_exposure_msat`, we'll reject the
9376         // update. At HTLC reception (`update_add_htlc()`), if the sum of the trimmed-to-dust HTLC
9377         // inbound and trimmed-to-dust HTLC outbound balance and this new received HTLC as included
9378         // on next counterparty commitment are above our `max_dust_htlc_exposure_msat`, we'll fail
9379         // the update. Note, we return a `temporary_channel_failure` (0x1000 | 7), as the channel
9380         // might be available again for HTLC processing once the dust bandwidth has cleared up.
9381
9382         let chanmon_cfgs = create_chanmon_cfgs(2);
9383         let mut config = test_default_channel_config();
9384         config.channel_config.max_dust_htlc_exposure_msat = 5_000_000; // default setting value
9385         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9386         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), None]);
9387         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9388
9389         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
9390         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9391         open_channel.max_htlc_value_in_flight_msat = 50_000_000;
9392         open_channel.max_accepted_htlcs = 60;
9393         if on_holder_tx {
9394                 open_channel.dust_limit_satoshis = 546;
9395         }
9396         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
9397         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9398         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
9399
9400         let opt_anchors = false;
9401
9402         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
9403
9404         if on_holder_tx {
9405                 let mut node_0_per_peer_lock;
9406                 let mut node_0_peer_state_lock;
9407                 let mut chan = get_channel_ref!(nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, temporary_channel_id);
9408                 chan.holder_dust_limit_satoshis = 546;
9409         }
9410
9411         nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
9412         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()));
9413         check_added_monitors!(nodes[1], 1);
9414
9415         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()));
9416         check_added_monitors!(nodes[0], 1);
9417
9418         let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9419         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
9420         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9421
9422         let dust_buffer_feerate = {
9423                 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
9424                 let chan_lock = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
9425                 let chan = chan_lock.channel_by_id.get(&channel_id).unwrap();
9426                 chan.get_dust_buffer_feerate(None) as u64
9427         };
9428         let dust_outbound_htlc_on_holder_tx_msat: u64 = (dust_buffer_feerate * htlc_timeout_tx_weight(opt_anchors) / 1000 + open_channel.dust_limit_satoshis - 1) * 1000;
9429         let dust_outbound_htlc_on_holder_tx: u64 = config.channel_config.max_dust_htlc_exposure_msat / dust_outbound_htlc_on_holder_tx_msat;
9430
9431         let dust_inbound_htlc_on_holder_tx_msat: u64 = (dust_buffer_feerate * htlc_success_tx_weight(opt_anchors) / 1000 + open_channel.dust_limit_satoshis - 1) * 1000;
9432         let dust_inbound_htlc_on_holder_tx: u64 = config.channel_config.max_dust_htlc_exposure_msat / dust_inbound_htlc_on_holder_tx_msat;
9433
9434         let dust_htlc_on_counterparty_tx: u64 = 25;
9435         let dust_htlc_on_counterparty_tx_msat: u64 = config.channel_config.max_dust_htlc_exposure_msat / dust_htlc_on_counterparty_tx;
9436
9437         if on_holder_tx {
9438                 if dust_outbound_balance {
9439                         // Outbound dust threshold: 2223 sats (`dust_buffer_feerate` * HTLC_TIMEOUT_TX_WEIGHT / 1000 + holder's `dust_limit_satoshis`)
9440                         // Outbound dust balance: 4372 sats
9441                         // Note, we need sent payment to be above outbound dust threshold on counterparty_tx of 2132 sats
9442                         for i in 0..dust_outbound_htlc_on_holder_tx {
9443                                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], dust_outbound_htlc_on_holder_tx_msat);
9444                                 if let Err(_) = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)) { panic!("Unexpected event at dust HTLC {}", i); }
9445                         }
9446                 } else {
9447                         // Inbound dust threshold: 2324 sats (`dust_buffer_feerate` * HTLC_SUCCESS_TX_WEIGHT / 1000 + holder's `dust_limit_satoshis`)
9448                         // Inbound dust balance: 4372 sats
9449                         // Note, we need sent payment to be above outbound dust threshold on counterparty_tx of 2031 sats
9450                         for _ in 0..dust_inbound_htlc_on_holder_tx {
9451                                 route_payment(&nodes[1], &[&nodes[0]], dust_inbound_htlc_on_holder_tx_msat);
9452                         }
9453                 }
9454         } else {
9455                 if dust_outbound_balance {
9456                         // Outbound dust threshold: 2132 sats (`dust_buffer_feerate` * HTLC_TIMEOUT_TX_WEIGHT / 1000 + counteparty's `dust_limit_satoshis`)
9457                         // Outbound dust balance: 5000 sats
9458                         for i in 0..dust_htlc_on_counterparty_tx {
9459                                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], dust_htlc_on_counterparty_tx_msat);
9460                                 if let Err(_) = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)) { panic!("Unexpected event at dust HTLC {}", i); }
9461                         }
9462                 } else {
9463                         // Inbound dust threshold: 2031 sats (`dust_buffer_feerate` * HTLC_TIMEOUT_TX_WEIGHT / 1000 + counteparty's `dust_limit_satoshis`)
9464                         // Inbound dust balance: 5000 sats
9465                         for _ in 0..dust_htlc_on_counterparty_tx {
9466                                 route_payment(&nodes[1], &[&nodes[0]], dust_htlc_on_counterparty_tx_msat);
9467                         }
9468                 }
9469         }
9470
9471         let dust_overflow = dust_htlc_on_counterparty_tx_msat * (dust_htlc_on_counterparty_tx + 1);
9472         if exposure_breach_event == ExposureEvent::AtHTLCForward {
9473                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], if on_holder_tx { dust_outbound_htlc_on_holder_tx_msat } else { dust_htlc_on_counterparty_tx_msat });
9474                 let mut config = UserConfig::default();
9475                 // With default dust exposure: 5000 sats
9476                 if on_holder_tx {
9477                         let dust_outbound_overflow = dust_outbound_htlc_on_holder_tx_msat * (dust_outbound_htlc_on_holder_tx + 1);
9478                         let dust_inbound_overflow = dust_inbound_htlc_on_holder_tx_msat * dust_inbound_htlc_on_holder_tx + dust_outbound_htlc_on_holder_tx_msat;
9479                         unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)), 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", if dust_outbound_balance { dust_outbound_overflow } else { dust_inbound_overflow }, config.channel_config.max_dust_htlc_exposure_msat)));
9480                 } else {
9481                         unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)), 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", dust_overflow, config.channel_config.max_dust_htlc_exposure_msat)));
9482                 }
9483         } else if exposure_breach_event == ExposureEvent::AtHTLCReception {
9484                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], if on_holder_tx { dust_inbound_htlc_on_holder_tx_msat } else { dust_htlc_on_counterparty_tx_msat });
9485                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
9486                 check_added_monitors!(nodes[1], 1);
9487                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
9488                 assert_eq!(events.len(), 1);
9489                 let payment_event = SendEvent::from_event(events.remove(0));
9490                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
9491                 // With default dust exposure: 5000 sats
9492                 if on_holder_tx {
9493                         // Outbound dust balance: 6399 sats
9494                         let dust_inbound_overflow = dust_inbound_htlc_on_holder_tx_msat * (dust_inbound_htlc_on_holder_tx + 1);
9495                         let dust_outbound_overflow = dust_outbound_htlc_on_holder_tx_msat * dust_outbound_htlc_on_holder_tx + dust_inbound_htlc_on_holder_tx_msat;
9496                         nodes[0].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", if dust_outbound_balance { dust_outbound_overflow } else { dust_inbound_overflow }, config.channel_config.max_dust_htlc_exposure_msat), 1);
9497                 } else {
9498                         // Outbound dust balance: 5200 sats
9499                         nodes[0].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", dust_overflow, config.channel_config.max_dust_htlc_exposure_msat), 1);
9500                 }
9501         } else if exposure_breach_event == ExposureEvent::AtUpdateFeeOutbound {
9502                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 2_500_000);
9503                 if let Err(_) = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)) { panic!("Unexpected event at update_fee-swallowed HTLC", ); }
9504                 {
9505                         let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
9506                         *feerate_lock = *feerate_lock * 10;
9507                 }
9508                 nodes[0].node.timer_tick_occurred();
9509                 check_added_monitors!(nodes[0], 1);
9510                 nodes[0].logger.assert_log_contains("lightning::ln::channel".to_string(), "Cannot afford to send new feerate at 2530 without infringing max dust htlc exposure".to_string(), 1);
9511         }
9512
9513         let _ = nodes[0].node.get_and_clear_pending_msg_events();
9514         let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9515         added_monitors.clear();
9516 }
9517
9518 #[test]
9519 fn test_max_dust_htlc_exposure() {
9520         do_test_max_dust_htlc_exposure(true, ExposureEvent::AtHTLCForward, true);
9521         do_test_max_dust_htlc_exposure(false, ExposureEvent::AtHTLCForward, true);
9522         do_test_max_dust_htlc_exposure(false, ExposureEvent::AtHTLCReception, true);
9523         do_test_max_dust_htlc_exposure(false, ExposureEvent::AtHTLCReception, false);
9524         do_test_max_dust_htlc_exposure(true, ExposureEvent::AtHTLCForward, false);
9525         do_test_max_dust_htlc_exposure(true, ExposureEvent::AtHTLCReception, false);
9526         do_test_max_dust_htlc_exposure(true, ExposureEvent::AtHTLCReception, true);
9527         do_test_max_dust_htlc_exposure(false, ExposureEvent::AtHTLCForward, false);
9528         do_test_max_dust_htlc_exposure(true, ExposureEvent::AtUpdateFeeOutbound, true);
9529         do_test_max_dust_htlc_exposure(true, ExposureEvent::AtUpdateFeeOutbound, false);
9530         do_test_max_dust_htlc_exposure(false, ExposureEvent::AtUpdateFeeOutbound, false);
9531         do_test_max_dust_htlc_exposure(false, ExposureEvent::AtUpdateFeeOutbound, true);
9532 }
9533
9534 #[test]
9535 fn test_non_final_funding_tx() {
9536         let chanmon_cfgs = create_chanmon_cfgs(2);
9537         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9538         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9539         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9540
9541         let temp_channel_id = nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
9542         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9543         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_message);
9544         let accept_channel_message = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9545         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel_message);
9546
9547         let best_height = nodes[0].node.best_block.read().unwrap().height();
9548
9549         let chan_id = *nodes[0].network_chan_count.borrow();
9550         let events = nodes[0].node.get_and_clear_pending_events();
9551         let input = TxIn { previous_output: BitcoinOutPoint::null(), script_sig: bitcoin::Script::new(), sequence: Sequence(1), witness: Witness::from_vec(vec!(vec!(1))) };
9552         assert_eq!(events.len(), 1);
9553         let mut tx = match events[0] {
9554                 Event::FundingGenerationReady { ref channel_value_satoshis, ref output_script, .. } => {
9555                         // Timelock the transaction _beyond_ the best client height + 2.
9556                         Transaction { version: chan_id as i32, lock_time: PackedLockTime(best_height + 3), input: vec![input], output: vec![TxOut {
9557                                 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
9558                         }]}
9559                 },
9560                 _ => panic!("Unexpected event"),
9561         };
9562         // Transaction should fail as it's evaluated as non-final for propagation.
9563         match nodes[0].node.funding_transaction_generated(&temp_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()) {
9564                 Err(APIError::APIMisuseError { err }) => {
9565                         assert_eq!(format!("Funding transaction absolute timelock is non-final"), err);
9566                 },
9567                 _ => panic!()
9568         }
9569
9570         // However, transaction should be accepted if it's in a +2 headroom from best block.
9571         tx.lock_time = PackedLockTime(tx.lock_time.0 - 1);
9572         assert!(nodes[0].node.funding_transaction_generated(&temp_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).is_ok());
9573         get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9574 }
9575
9576 #[test]
9577 fn accept_busted_but_better_fee() {
9578         // If a peer sends us a fee update that is too low, but higher than our previous channel
9579         // feerate, we should accept it. In the future we may want to consider closing the channel
9580         // later, but for now we only accept the update.
9581         let mut chanmon_cfgs = create_chanmon_cfgs(2);
9582         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9583         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9584         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9585
9586         create_chan_between_nodes(&nodes[0], &nodes[1]);
9587
9588         // Set nodes[1] to expect 5,000 sat/kW.
9589         {
9590                 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
9591                 *feerate_lock = 5000;
9592         }
9593
9594         // If nodes[0] increases their feerate, even if its not enough, nodes[1] should accept it.
9595         {
9596                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
9597                 *feerate_lock = 1000;
9598         }
9599         nodes[0].node.timer_tick_occurred();
9600         check_added_monitors!(nodes[0], 1);
9601
9602         let events = nodes[0].node.get_and_clear_pending_msg_events();
9603         assert_eq!(events.len(), 1);
9604         match events[0] {
9605                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
9606                         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_fee.as_ref().unwrap());
9607                         commitment_signed_dance!(nodes[1], nodes[0], commitment_signed, false);
9608                 },
9609                 _ => panic!("Unexpected event"),
9610         };
9611
9612         // If nodes[0] increases their feerate further, even if its not enough, nodes[1] should accept
9613         // it.
9614         {
9615                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
9616                 *feerate_lock = 2000;
9617         }
9618         nodes[0].node.timer_tick_occurred();
9619         check_added_monitors!(nodes[0], 1);
9620
9621         let events = nodes[0].node.get_and_clear_pending_msg_events();
9622         assert_eq!(events.len(), 1);
9623         match events[0] {
9624                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
9625                         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_fee.as_ref().unwrap());
9626                         commitment_signed_dance!(nodes[1], nodes[0], commitment_signed, false);
9627                 },
9628                 _ => panic!("Unexpected event"),
9629         };
9630
9631         // However, if nodes[0] decreases their feerate, nodes[1] should reject it and close the
9632         // channel.
9633         {
9634                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
9635                 *feerate_lock = 1000;
9636         }
9637         nodes[0].node.timer_tick_occurred();
9638         check_added_monitors!(nodes[0], 1);
9639
9640         let events = nodes[0].node.get_and_clear_pending_msg_events();
9641         assert_eq!(events.len(), 1);
9642         match events[0] {
9643                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
9644                         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_fee.as_ref().unwrap());
9645                         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError {
9646                                 err: "Peer's feerate much too low. Actual: 1000. Our expected lower limit: 5000 (- 250)".to_owned() });
9647                         check_closed_broadcast!(nodes[1], true);
9648                         check_added_monitors!(nodes[1], 1);
9649                 },
9650                 _ => panic!("Unexpected event"),
9651         };
9652 }
9653
9654 fn do_payment_with_custom_min_final_cltv_expiry(valid_delta: bool, use_user_hash: bool) {
9655         let mut chanmon_cfgs = create_chanmon_cfgs(2);
9656         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9657         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9658         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9659         let min_final_cltv_expiry_delta = 120;
9660         let final_cltv_expiry_delta = if valid_delta { min_final_cltv_expiry_delta + 2 } else {
9661                 min_final_cltv_expiry_delta - 2 };
9662         let recv_value = 100_000;
9663
9664         create_chan_between_nodes(&nodes[0], &nodes[1]);
9665
9666         let payment_parameters = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), final_cltv_expiry_delta as u32);
9667         let (payment_hash, payment_preimage, payment_secret) = if use_user_hash {
9668                 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1],
9669                         Some(recv_value), Some(min_final_cltv_expiry_delta));
9670                 (payment_hash, payment_preimage, payment_secret)
9671         } else {
9672                 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(recv_value), 7200, Some(min_final_cltv_expiry_delta)).unwrap();
9673                 (payment_hash, nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap(), payment_secret)
9674         };
9675         let route = get_route!(nodes[0], payment_parameters, recv_value, final_cltv_expiry_delta as u32).unwrap();
9676         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
9677         check_added_monitors!(nodes[0], 1);
9678         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9679         assert_eq!(events.len(), 1);
9680         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
9681         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9682         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9683         expect_pending_htlcs_forwardable!(nodes[1]);
9684
9685         if valid_delta {
9686                 expect_payment_claimable!(nodes[1], payment_hash, payment_secret, recv_value, if use_user_hash {
9687                         None } else { Some(payment_preimage) }, nodes[1].node.get_our_node_id());
9688
9689                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
9690         } else {
9691                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
9692
9693                 check_added_monitors!(nodes[1], 1);
9694
9695                 let fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9696                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_updates.update_fail_htlcs[0]);
9697                 commitment_signed_dance!(nodes[0], nodes[1], fail_updates.commitment_signed, false, true);
9698
9699                 expect_payment_failed!(nodes[0], payment_hash, true);
9700         }
9701 }
9702
9703 #[test]
9704 fn test_payment_with_custom_min_cltv_expiry_delta() {
9705         do_payment_with_custom_min_final_cltv_expiry(false, false);
9706         do_payment_with_custom_min_final_cltv_expiry(false, true);
9707         do_payment_with_custom_min_final_cltv_expiry(true, false);
9708         do_payment_with_custom_min_final_cltv_expiry(true, true);
9709 }