_ Git - rust-lightning/blob - lightning/src/ln/functional_tests.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   7 // You may not use this file except in accordance with one or both of these
   8 // licenses.
   9
  10 //! Tests that test standing up a network of ChannelManagers, creating channels, sending
  11 //! payments/messages between them, and often checking the resulting ChannelMonitors are able to
  12 //! claim outputs on-chain.
  13
  14 use chain;
  15 use chain::{Confirm, Listen, Watch};
  16 use chain::channelmonitor;
  17 use chain::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
  18 use chain::transaction::OutPoint;
  19 use chain::keysinterface::BaseSign;
  20 use ln::{PaymentPreimage, PaymentSecret, PaymentHash};
  21 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
  22 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, PaymentId, RAACommitmentOrder, PaymentSendFailure, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA};
  23 use ln::channel::{Channel, ChannelError};
  24 use ln::{chan_utils, onion_utils};
  25 use ln::chan_utils::HTLC_SUCCESS_TX_WEIGHT;
  26 use routing::network_graph::{NetworkUpdate, RoutingFees};
  27 use routing::router::{Payee, Route, RouteHop, RouteHint, RouteHintHop, RouteParameters, find_route, get_route};
  28 use routing::scorer::Scorer;
  29 use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
  30 use ln::msgs;
  31 use ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
  32 use util::enforcing_trait_impls::EnforcingSigner;
  33 use util::{byte_utils, test_utils};
  34 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose, ClosureReason};
  35 use util::errors::APIError;
  36 use util::ser::{Writeable, ReadableArgs};
  37 use util::config::UserConfig;
  38
  39 use bitcoin::hash_types::BlockHash;
  40 use bitcoin::blockdata::block::{Block, BlockHeader};
  41 use bitcoin::blockdata::script::Builder;
  42 use bitcoin::blockdata::opcodes;
  43 use bitcoin::blockdata::constants::genesis_block;
  44 use bitcoin::network::constants::Network;
  45
  46 use bitcoin::hashes::sha256::Hash as Sha256;
  47 use bitcoin::hashes::Hash;
  48
  49 use bitcoin::secp256k1::Secp256k1;
  50 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
  51
  52 use regex;
  53
  54 use io;
  55 use prelude::*;
  56 use alloc::collections::BTreeSet;
  57 use core::default::Default;
  58 use sync::{Arc, Mutex};
  59
  60 use ln::functional_test_utils::*;
  61 use ln::chan_utils::CommitmentTransaction;
  62
  63 #[test]
  64 fn test_insane_channel_opens() {
  65         // Stand up a network of 2 nodes
  66         let chanmon_cfgs = create_chanmon_cfgs(2);
  67         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  68         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  69         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  70
  71         // Instantiate channel parameters where we push the maximum msats given our
  72         // funding satoshis
  73         let channel_value_sat = 31337; // same as funding satoshis
  74         let channel_reserve_satoshis = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value_sat);
  75         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  76
  77         // Have node0 initiate a channel to node1 with aforementioned parameters
  78         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
  79
  80         // Extract the channel open message from node0 to node1
  81         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  82
  83         // Test helper that asserts we get the correct error string given a mutator
  84         // that supposedly makes the channel open message insane
  85         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  86                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
  87                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  88                 assert_eq!(msg_events.len(), 1);
  89                 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
  90                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  91                         match action {
  92                                 &ErrorAction::SendErrorMessage { .. } => {
  93                                         nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
  94                                 },
  95                                 _ => panic!("unexpected event!"),
  96                         }
  97                 } else { assert!(false); }
  98         };
  99
 100         use ln::channel::MAX_FUNDING_SATOSHIS;
 101         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
 102
 103         // Test all mutations that would make the channel open message insane
 104         insane_open_helper(format!("Funding must be smaller than {}. It was {}", MAX_FUNDING_SATOSHIS, MAX_FUNDING_SATOSHIS).as_str(), |mut msg| { msg.funding_satoshis = MAX_FUNDING_SATOSHIS; msg });
 105
 106         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
 107
 108         insane_open_helper(r"push_msat \d+ was larger than funding value \d+", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
 109
 110         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
 111
 112         insane_open_helper(r"Bogus; channel reserve \(\d+\) is less than dust limit \(\d+\)", |mut msg| { msg.dust_limit_satoshis = msg.channel_reserve_satoshis + 1; msg });
 113
 114         insane_open_helper(r"Minimum htlc value \(\d+\) was larger than full channel value \(\d+\)", |mut msg| { msg.htlc_minimum_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000; msg });
 115
 116         insane_open_helper("They wanted our payments to be delayed by a needlessly long period", |mut msg| { msg.to_self_delay = MAX_LOCAL_BREAKDOWN_TIMEOUT + 1; msg });
 117
 118         insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 119
 120         insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 121 }
 122
 123 #[test]
 124 fn test_async_inbound_update_fee() {
 125         let chanmon_cfgs = create_chanmon_cfgs(2);
 126         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 127         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 128         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 129         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 130
 131         // balancing
 132         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 133
 134         // A                                        B
 135         // update_fee                            ->
 136         // send (1) commitment_signed            -.
 137         //                                       <- update_add_htlc/commitment_signed
 138         // send (2) RAA (awaiting remote revoke) -.
 139         // (1) commitment_signed is delivered    ->
 140         //                                       .- send (3) RAA (awaiting remote revoke)
 141         // (2) RAA is delivered                  ->
 142         //                                       .- send (4) commitment_signed
 143         //                                       <- (3) RAA is delivered
 144         // send (5) commitment_signed            -.
 145         //                                       <- (4) commitment_signed is delivered
 146         // send (6) RAA                          -.
 147         // (5) commitment_signed is delivered    ->
 148         //                                       <- RAA
 149         // (6) RAA is delivered                  ->
 150
 151         // First nodes[0] generates an update_fee
 152         {
 153                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 154                 *feerate_lock += 20;
 155         }
 156         nodes[0].node.timer_tick_occurred();
 157         check_added_monitors!(nodes[0], 1);
 158
 159         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 160         assert_eq!(events_0.len(), 1);
 161         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 162                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 163                         (update_fee.as_ref(), commitment_signed)
 164                 },
 165                 _ => panic!("Unexpected event"),
 166         };
 167
 168         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 169
 170         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 171         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 40000);
 172         nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
 173         check_added_monitors!(nodes[1], 1);
 174
 175         let payment_event = {
 176                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 177                 assert_eq!(events_1.len(), 1);
 178                 SendEvent::from_event(events_1.remove(0))
 179         };
 180         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 181         assert_eq!(payment_event.msgs.len(), 1);
 182
 183         // ...now when the messages get delivered everyone should be happy
 184         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 185         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 186         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 187         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 188         check_added_monitors!(nodes[0], 1);
 189
 190         // deliver(1), generate (3):
 191         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 192         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 193         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 194         check_added_monitors!(nodes[1], 1);
 195
 196         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 197         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 198         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 199         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 200         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 201         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 202         assert!(bs_update.update_fee.is_none()); // (4)
 203         check_added_monitors!(nodes[1], 1);
 204
 205         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 206         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 207         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 208         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 209         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 210         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 211         assert!(as_update.update_fee.is_none()); // (5)
 212         check_added_monitors!(nodes[0], 1);
 213
 214         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 215         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 216         // only (6) so get_event_msg's assert(len == 1) passes
 217         check_added_monitors!(nodes[0], 1);
 218
 219         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 220         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 221         check_added_monitors!(nodes[1], 1);
 222
 223         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 224         check_added_monitors!(nodes[0], 1);
 225
 226         let events_2 = nodes[0].node.get_and_clear_pending_events();
 227         assert_eq!(events_2.len(), 1);
 228         match events_2[0] {
 229                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 230                 _ => panic!("Unexpected event"),
 231         }
 232
 233         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 234         check_added_monitors!(nodes[1], 1);
 235 }
 236
 237 #[test]
 238 fn test_update_fee_unordered_raa() {
 239         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 240         // crash in an earlier version of the update_fee patch)
 241         let chanmon_cfgs = create_chanmon_cfgs(2);
 242         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 243         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 244         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 245         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 246
 247         // balancing
 248         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 249
 250         // First nodes[0] generates an update_fee
 251         {
 252                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 253                 *feerate_lock += 20;
 254         }
 255         nodes[0].node.timer_tick_occurred();
 256         check_added_monitors!(nodes[0], 1);
 257
 258         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 259         assert_eq!(events_0.len(), 1);
 260         let update_msg = match events_0[0] { // (1)
 261                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 262                         update_fee.as_ref()
 263                 },
 264                 _ => panic!("Unexpected event"),
 265         };
 266
 267         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 268
 269         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 270         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 40000);
 271         nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
 272         check_added_monitors!(nodes[1], 1);
 273
 274         let payment_event = {
 275                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 276                 assert_eq!(events_1.len(), 1);
 277                 SendEvent::from_event(events_1.remove(0))
 278         };
 279         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 280         assert_eq!(payment_event.msgs.len(), 1);
 281
 282         // ...now when the messages get delivered everyone should be happy
 283         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 284         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 285         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 286         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 287         check_added_monitors!(nodes[0], 1);
 288
 289         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 290         check_added_monitors!(nodes[1], 1);
 291
 292         // We can't continue, sadly, because our (1) now has a bogus signature
 293 }
 294
 295 #[test]
 296 fn test_multi_flight_update_fee() {
 297         let chanmon_cfgs = create_chanmon_cfgs(2);
 298         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 299         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 300         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 301         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 302
 303         // A                                        B
 304         // update_fee/commitment_signed          ->
 305         //                                       .- send (1) RAA and (2) commitment_signed
 306         // update_fee (never committed)          ->
 307         // (3) update_fee                        ->
 308         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 309         // don't track which updates correspond to which revoke_and_ack responses so we're in
 310         // AwaitingRAA mode and will not generate the update_fee yet.
 311         //                                       <- (1) RAA delivered
 312         // (3) is generated and send (4) CS      -.
 313         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 314         // know the per_commitment_point to use for it.
 315         //                                       <- (2) commitment_signed delivered
 316         // revoke_and_ack                        ->
 317         //                                          B should send no response here
 318         // (4) commitment_signed delivered       ->
 319         //                                       <- RAA/commitment_signed delivered
 320         // revoke_and_ack                        ->
 321
 322         // First nodes[0] generates an update_fee
 323         let initial_feerate;
 324         {
 325                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 326                 initial_feerate = *feerate_lock;
 327                 *feerate_lock = initial_feerate + 20;
 328         }
 329         nodes[0].node.timer_tick_occurred();
 330         check_added_monitors!(nodes[0], 1);
 331
 332         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 333         assert_eq!(events_0.len(), 1);
 334         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 335                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 336                         (update_fee.as_ref().unwrap(), commitment_signed)
 337                 },
 338                 _ => panic!("Unexpected event"),
 339         };
 340
 341         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 342         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 343         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 344         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 345         check_added_monitors!(nodes[1], 1);
 346
 347         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 348         // transaction:
 349         {
 350                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 351                 *feerate_lock = initial_feerate + 40;
 352         }
 353         nodes[0].node.timer_tick_occurred();
 354         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 355         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 356
 357         // Create the (3) update_fee message that nodes[0] will generate before it does...
 358         let mut update_msg_2 = msgs::UpdateFee {
 359                 channel_id: update_msg_1.channel_id.clone(),
 360                 feerate_per_kw: (initial_feerate + 30) as u32,
 361         };
 362
 363         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 364
 365         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 366         // Deliver (3)
 367         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 368
 369         // Deliver (1), generating (3) and (4)
 370         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 371         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 372         check_added_monitors!(nodes[0], 1);
 373         assert!(as_second_update.update_add_htlcs.is_empty());
 374         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 375         assert!(as_second_update.update_fail_htlcs.is_empty());
 376         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 377         // Check that the update_fee newly generated matches what we delivered:
 378         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 379         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 380
 381         // Deliver (2) commitment_signed
 382         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 383         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 384         check_added_monitors!(nodes[0], 1);
 385         // No commitment_signed so get_event_msg's assert(len == 1) passes
 386
 387         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 388         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 389         check_added_monitors!(nodes[1], 1);
 390
 391         // Delever (4)
 392         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 393         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 394         check_added_monitors!(nodes[1], 1);
 395
 396         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 397         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 398         check_added_monitors!(nodes[0], 1);
 399
 400         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 401         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 402         // No commitment_signed so get_event_msg's assert(len == 1) passes
 403         check_added_monitors!(nodes[0], 1);
 404
 405         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 406         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 407         check_added_monitors!(nodes[1], 1);
 408 }
 409
 410 fn do_test_1_conf_open(connect_style: ConnectStyle) {
 411         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 412         // tests that we properly send one in that case.
 413         let mut alice_config = UserConfig::default();
 414         alice_config.own_channel_config.minimum_depth = 1;
 415         alice_config.channel_options.announced_channel = true;
 416         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 417         let mut bob_config = UserConfig::default();
 418         bob_config.own_channel_config.minimum_depth = 1;
 419         bob_config.channel_options.announced_channel = true;
 420         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 421         let chanmon_cfgs = create_chanmon_cfgs(2);
 422         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 423         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 424         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 425         *nodes[0].connect_style.borrow_mut() = connect_style;
 426
 427         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
 428         mine_transaction(&nodes[1], &tx);
 429         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[0].node.get_our_node_id()));
 430
 431         mine_transaction(&nodes[0], &tx);
 432         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 433         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 434
 435         for node in nodes {
 436                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
 437                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
 438                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
 439         }
 440 }
 441 #[test]
 442 fn test_1_conf_open() {
 443         do_test_1_conf_open(ConnectStyle::BestBlockFirst);
 444         do_test_1_conf_open(ConnectStyle::TransactionsFirst);
 445         do_test_1_conf_open(ConnectStyle::FullBlockViaListen);
 446 }
 447
 448 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 449         // Previously, we had issues deserializing channels when we hadn't connected the first block
 450         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 451         // serialization round-trips and simply do steps towards opening a channel and then drop the
 452         // Node objects.
 453
 454         let chanmon_cfgs = create_chanmon_cfgs(2);
 455         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 456         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 457         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 458
 459         if steps & 0b1000_0000 != 0{
 460                 let block = Block {
 461                         header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 462                         txdata: vec![],
 463                 };
 464                 connect_block(&nodes[0], &block);
 465                 connect_block(&nodes[1], &block);
 466         }
 467
 468         if steps & 0x0f == 0 { return; }
 469         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 470         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 471
 472         if steps & 0x0f == 1 { return; }
 473         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
 474         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 475
 476         if steps & 0x0f == 2 { return; }
 477         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
 478
 479         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 480
 481         if steps & 0x0f == 3 { return; }
 482         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
 483         check_added_monitors!(nodes[0], 0);
 484         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 485
 486         if steps & 0x0f == 4 { return; }
 487         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 488         {
 489                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 490                 assert_eq!(added_monitors.len(), 1);
 491                 assert_eq!(added_monitors[0].0, funding_output);
 492                 added_monitors.clear();
 493         }
 494         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 495
 496         if steps & 0x0f == 5 { return; }
 497         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 498         {
 499                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 500                 assert_eq!(added_monitors.len(), 1);
 501                 assert_eq!(added_monitors[0].0, funding_output);
 502                 added_monitors.clear();
 503         }
 504
 505         let events_4 = nodes[0].node.get_and_clear_pending_events();
 506         assert_eq!(events_4.len(), 0);
 507
 508         if steps & 0x0f == 6 { return; }
 509         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
 510
 511         if steps & 0x0f == 7 { return; }
 512         confirm_transaction_at(&nodes[0], &tx, 2);
 513         connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
 514         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 515 }
 516
 517 #[test]
 518 fn test_sanity_on_in_flight_opens() {
 519         do_test_sanity_on_in_flight_opens(0);
 520         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 521         do_test_sanity_on_in_flight_opens(1);
 522         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 523         do_test_sanity_on_in_flight_opens(2);
 524         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 525         do_test_sanity_on_in_flight_opens(3);
 526         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 527         do_test_sanity_on_in_flight_opens(4);
 528         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 529         do_test_sanity_on_in_flight_opens(5);
 530         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 531         do_test_sanity_on_in_flight_opens(6);
 532         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 533         do_test_sanity_on_in_flight_opens(7);
 534         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 535         do_test_sanity_on_in_flight_opens(8);
 536         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 537 }
 538
 539 #[test]
 540 fn test_update_fee_vanilla() {
 541         let chanmon_cfgs = create_chanmon_cfgs(2);
 542         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 543         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 544         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 545         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 546
 547         {
 548                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 549                 *feerate_lock += 25;
 550         }
 551         nodes[0].node.timer_tick_occurred();
 552         check_added_monitors!(nodes[0], 1);
 553
 554         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 555         assert_eq!(events_0.len(), 1);
 556         let (update_msg, commitment_signed) = match events_0[0] {
 557                         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 } } => {
 558                         (update_fee.as_ref(), commitment_signed)
 559                 },
 560                 _ => panic!("Unexpected event"),
 561         };
 562         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 563
 564         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 565         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 566         check_added_monitors!(nodes[1], 1);
 567
 568         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 569         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 570         check_added_monitors!(nodes[0], 1);
 571
 572         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 573         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 574         // No commitment_signed so get_event_msg's assert(len == 1) passes
 575         check_added_monitors!(nodes[0], 1);
 576
 577         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 578         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 579         check_added_monitors!(nodes[1], 1);
 580 }
 581
 582 #[test]
 583 fn test_update_fee_that_funder_cannot_afford() {
 584         let chanmon_cfgs = create_chanmon_cfgs(2);
 585         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 586         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 587         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 588         let channel_value = 1888;
 589         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
 590         let channel_id = chan.2;
 591
 592         let feerate = 260;
 593         {
 594                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 595                 *feerate_lock = feerate;
 596         }
 597         nodes[0].node.timer_tick_occurred();
 598         check_added_monitors!(nodes[0], 1);
 599         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 600
 601         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 602
 603         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 604
 605         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 606         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 607         {
 608                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 609
 610                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 611                 let num_htlcs = commitment_tx.output.len() - 2;
 612                 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 613                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 614                 actual_fee = channel_value - actual_fee;
 615                 assert_eq!(total_fee, actual_fee);
 616         }
 617
 618         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 619         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 620         {
 621                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 622                 *feerate_lock = feerate + 2;
 623         }
 624         nodes[0].node.timer_tick_occurred();
 625         check_added_monitors!(nodes[0], 1);
 626
 627         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 628
 629         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 630
 631         //While producing the commitment_signed response after handling a received update_fee request the
 632         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 633         //Should produce and error.
 634         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 635         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 636         check_added_monitors!(nodes[1], 1);
 637         check_closed_broadcast!(nodes[1], true);
 638         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: String::from("Funding remote cannot afford proposed new fee") });
 639 }
 640
 641 #[test]
 642 fn test_update_fee_with_fundee_update_add_htlc() {
 643         let chanmon_cfgs = create_chanmon_cfgs(2);
 644         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 645         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 646         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 647         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 648
 649         // balancing
 650         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 651
 652         {
 653                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 654                 *feerate_lock += 20;
 655         }
 656         nodes[0].node.timer_tick_occurred();
 657         check_added_monitors!(nodes[0], 1);
 658
 659         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 660         assert_eq!(events_0.len(), 1);
 661         let (update_msg, commitment_signed) = match events_0[0] {
 662                         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 } } => {
 663                         (update_fee.as_ref(), commitment_signed)
 664                 },
 665                 _ => panic!("Unexpected event"),
 666         };
 667         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 668         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 669         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 670         check_added_monitors!(nodes[1], 1);
 671
 672         let (route, our_payment_hash, our_payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 800000);
 673
 674         // nothing happens since node[1] is in AwaitingRemoteRevoke
 675         nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
 676         {
 677                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 678                 assert_eq!(added_monitors.len(), 0);
 679                 added_monitors.clear();
 680         }
 681         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 682         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 683         // node[1] has nothing to do
 684
 685         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 686         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 687         check_added_monitors!(nodes[0], 1);
 688
 689         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 690         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 691         // No commitment_signed so get_event_msg's assert(len == 1) passes
 692         check_added_monitors!(nodes[0], 1);
 693         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 694         check_added_monitors!(nodes[1], 1);
 695         // AwaitingRemoteRevoke ends here
 696
 697         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 698         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 699         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 700         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 701         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 702         assert_eq!(commitment_update.update_fee.is_none(), true);
 703
 704         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 705         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 706         check_added_monitors!(nodes[0], 1);
 707         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 708
 709         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 710         check_added_monitors!(nodes[1], 1);
 711         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 712
 713         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 714         check_added_monitors!(nodes[1], 1);
 715         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 716         // No commitment_signed so get_event_msg's assert(len == 1) passes
 717
 718         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 719         check_added_monitors!(nodes[0], 1);
 720         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 721
 722         expect_pending_htlcs_forwardable!(nodes[0]);
 723
 724         let events = nodes[0].node.get_and_clear_pending_events();
 725         assert_eq!(events.len(), 1);
 726         match events[0] {
 727                 Event::PaymentReceived { .. } => { },
 728                 _ => panic!("Unexpected event"),
 729         };
 730
 731         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
 732
 733         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
 734         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
 735         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 736         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
 737         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
 738 }
 739
 740 #[test]
 741 fn test_update_fee() {
 742         let chanmon_cfgs = create_chanmon_cfgs(2);
 743         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 744         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 745         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 746         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 747         let channel_id = chan.2;
 748
 749         // A                                        B
 750         // (1) update_fee/commitment_signed      ->
 751         //                                       <- (2) revoke_and_ack
 752         //                                       .- send (3) commitment_signed
 753         // (4) update_fee/commitment_signed      ->
 754         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 755         //                                       <- (3) commitment_signed delivered
 756         // send (6) revoke_and_ack               -.
 757         //                                       <- (5) deliver revoke_and_ack
 758         // (6) deliver revoke_and_ack            ->
 759         //                                       .- send (7) commitment_signed in response to (4)
 760         //                                       <- (7) deliver commitment_signed
 761         // revoke_and_ack                        ->
 762
 763         // Create and deliver (1)...
 764         let feerate;
 765         {
 766                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 767                 feerate = *feerate_lock;
 768                 *feerate_lock = feerate + 20;
 769         }
 770         nodes[0].node.timer_tick_occurred();
 771         check_added_monitors!(nodes[0], 1);
 772
 773         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 774         assert_eq!(events_0.len(), 1);
 775         let (update_msg, commitment_signed) = match events_0[0] {
 776                         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 } } => {
 777                         (update_fee.as_ref(), commitment_signed)
 778                 },
 779                 _ => panic!("Unexpected event"),
 780         };
 781         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 782
 783         // Generate (2) and (3):
 784         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 785         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 786         check_added_monitors!(nodes[1], 1);
 787
 788         // Deliver (2):
 789         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 790         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 791         check_added_monitors!(nodes[0], 1);
 792
 793         // Create and deliver (4)...
 794         {
 795                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 796                 *feerate_lock = feerate + 30;
 797         }
 798         nodes[0].node.timer_tick_occurred();
 799         check_added_monitors!(nodes[0], 1);
 800         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 801         assert_eq!(events_0.len(), 1);
 802         let (update_msg, commitment_signed) = match events_0[0] {
 803                         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 } } => {
 804                         (update_fee.as_ref(), commitment_signed)
 805                 },
 806                 _ => panic!("Unexpected event"),
 807         };
 808
 809         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 810         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 811         check_added_monitors!(nodes[1], 1);
 812         // ... creating (5)
 813         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 814         // No commitment_signed so get_event_msg's assert(len == 1) passes
 815
 816         // Handle (3), creating (6):
 817         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 818         check_added_monitors!(nodes[0], 1);
 819         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 820         // No commitment_signed so get_event_msg's assert(len == 1) passes
 821
 822         // Deliver (5):
 823         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 824         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 825         check_added_monitors!(nodes[0], 1);
 826
 827         // Deliver (6), creating (7):
 828         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 829         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 830         assert!(commitment_update.update_add_htlcs.is_empty());
 831         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 832         assert!(commitment_update.update_fail_htlcs.is_empty());
 833         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 834         assert!(commitment_update.update_fee.is_none());
 835         check_added_monitors!(nodes[1], 1);
 836
 837         // Deliver (7)
 838         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 839         check_added_monitors!(nodes[0], 1);
 840         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 841         // No commitment_signed so get_event_msg's assert(len == 1) passes
 842
 843         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 844         check_added_monitors!(nodes[1], 1);
 845         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 846
 847         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 848         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 849         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 850         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
 851         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
 852 }
 853
 854 #[test]
 855 fn fake_network_test() {
 856         // Simple test which builds a network of ChannelManagers, connects them to each other, and
 857         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
 858         let chanmon_cfgs = create_chanmon_cfgs(4);
 859         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
 860         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
 861         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
 862
 863         // Create some initial channels
 864         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 865         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 866         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
 867
 868         // Rebalance the network a bit by relaying one payment through all the channels...
 869         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
 870         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
 871         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
 872         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
 873
 874         // Send some more payments
 875         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
 876         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
 877         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
 878
 879         // Test failure packets
 880         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
 881         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
 882
 883         // Add a new channel that skips 3
 884         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
 885
 886         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
 887         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
 888         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
 889         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
 890         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
 891         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
 892         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
 893
 894         // Do some rebalance loop payments, simultaneously
 895         let mut hops = Vec::with_capacity(3);
 896         hops.push(RouteHop {
 897                 pubkey: nodes[2].node.get_our_node_id(),
 898                 node_features: NodeFeatures::empty(),
 899                 short_channel_id: chan_2.0.contents.short_channel_id,
 900                 channel_features: ChannelFeatures::empty(),
 901                 fee_msat: 0,
 902                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
 903         });
 904         hops.push(RouteHop {
 905                 pubkey: nodes[3].node.get_our_node_id(),
 906                 node_features: NodeFeatures::empty(),
 907                 short_channel_id: chan_3.0.contents.short_channel_id,
 908                 channel_features: ChannelFeatures::empty(),
 909                 fee_msat: 0,
 910                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
 911         });
 912         hops.push(RouteHop {
 913                 pubkey: nodes[1].node.get_our_node_id(),
 914                 node_features: NodeFeatures::known(),
 915                 short_channel_id: chan_4.0.contents.short_channel_id,
 916                 channel_features: ChannelFeatures::known(),
 917                 fee_msat: 1000000,
 918                 cltv_expiry_delta: TEST_FINAL_CLTV,
 919         });
 920         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;
 921         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;
 922         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops], payee: None }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
 923
 924         let mut hops = Vec::with_capacity(3);
 925         hops.push(RouteHop {
 926                 pubkey: nodes[3].node.get_our_node_id(),
 927                 node_features: NodeFeatures::empty(),
 928                 short_channel_id: chan_4.0.contents.short_channel_id,
 929                 channel_features: ChannelFeatures::empty(),
 930                 fee_msat: 0,
 931                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
 932         });
 933         hops.push(RouteHop {
 934                 pubkey: nodes[2].node.get_our_node_id(),
 935                 node_features: NodeFeatures::empty(),
 936                 short_channel_id: chan_3.0.contents.short_channel_id,
 937                 channel_features: ChannelFeatures::empty(),
 938                 fee_msat: 0,
 939                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
 940         });
 941         hops.push(RouteHop {
 942                 pubkey: nodes[1].node.get_our_node_id(),
 943                 node_features: NodeFeatures::known(),
 944                 short_channel_id: chan_2.0.contents.short_channel_id,
 945                 channel_features: ChannelFeatures::known(),
 946                 fee_msat: 1000000,
 947                 cltv_expiry_delta: TEST_FINAL_CLTV,
 948         });
 949         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;
 950         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;
 951         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops], payee: None }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
 952
 953         // Claim the rebalances...
 954         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
 955         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
 956
 957         // Add a duplicate new channel from 2 to 4
 958         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
 959
 960         // Send some payments across both channels
 961         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
 962         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
 963         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
 964
 965
 966         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
 967         let events = nodes[0].node.get_and_clear_pending_msg_events();
 968         assert_eq!(events.len(), 0);
 969         nodes[0].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), regex::Regex::new(r"Cannot send value that would put us over the max HTLC value in flight our peer will accept \(\d+\)").unwrap(), 1);
 970
 971         //TODO: Test that routes work again here as we've been notified that the channel is full
 972
 973         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
 974         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
 975         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
 976
 977         // Close down the channels...
 978         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
 979         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
 980         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
 981         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
 982         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
 983         check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
 984         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
 985         check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
 986         check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure);
 987         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
 988         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
 989         check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure);
 990         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
 991         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
 992         check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure);
 993 }
 994
 995 #[test]
 996 fn holding_cell_htlc_counting() {
 997         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
 998         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
 999         // commitment dance rounds.
1000         let chanmon_cfgs = create_chanmon_cfgs(3);
1001         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1002         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1003         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1004         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1005         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1006
1007         let mut payments = Vec::new();
1008         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1009                 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[2], 100000);
1010                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
1011                 payments.push((payment_preimage, payment_hash));
1012         }
1013         check_added_monitors!(nodes[1], 1);
1014
1015         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1016         assert_eq!(events.len(), 1);
1017         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1018         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1019
1020         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1021         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1022         // another HTLC.
1023         let (route, payment_hash_1, _, payment_secret_1) = get_route_and_payment_hash!(nodes[1], nodes[2], 100000);
1024         {
1025                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable { ref err },
1026                         assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1027                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1028                 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1029         }
1030
1031         // This should also be true if we try to forward a payment.
1032         let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[2], 100000);
1033         {
1034                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1035                 check_added_monitors!(nodes[0], 1);
1036         }
1037
1038         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1039         assert_eq!(events.len(), 1);
1040         let payment_event = SendEvent::from_event(events.pop().unwrap());
1041         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1042
1043         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1044         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1045         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1046         // fails), the second will process the resulting failure and fail the HTLC backward.
1047         expect_pending_htlcs_forwardable!(nodes[1]);
1048         expect_pending_htlcs_forwardable!(nodes[1]);
1049         check_added_monitors!(nodes[1], 1);
1050
1051         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1052         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1053         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1054
1055         expect_payment_failed_with_update!(nodes[0], payment_hash_2, false, chan_2.0.contents.short_channel_id, false);
1056
1057         // Now forward all the pending HTLCs and claim them back
1058         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1059         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1060         check_added_monitors!(nodes[2], 1);
1061
1062         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1063         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1064         check_added_monitors!(nodes[1], 1);
1065         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1066
1067         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1068         check_added_monitors!(nodes[1], 1);
1069         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1070
1071         for ref update in as_updates.update_add_htlcs.iter() {
1072                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1073         }
1074         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1075         check_added_monitors!(nodes[2], 1);
1076         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1077         check_added_monitors!(nodes[2], 1);
1078         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1079
1080         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1081         check_added_monitors!(nodes[1], 1);
1082         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1083         check_added_monitors!(nodes[1], 1);
1084         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1085
1086         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1087         check_added_monitors!(nodes[2], 1);
1088
1089         expect_pending_htlcs_forwardable!(nodes[2]);
1090
1091         let events = nodes[2].node.get_and_clear_pending_events();
1092         assert_eq!(events.len(), payments.len());
1093         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1094                 match event {
1095                         &Event::PaymentReceived { ref payment_hash, .. } => {
1096                                 assert_eq!(*payment_hash, *hash);
1097                         },
1098                         _ => panic!("Unexpected event"),
1099                 };
1100         }
1101
1102         for (preimage, _) in payments.drain(..) {
1103                 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1104         }
1105
1106         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1107 }
1108
1109 #[test]
1110 fn duplicate_htlc_test() {
1111         // Test that we accept duplicate payment_hash HTLCs across the network and that
1112         // claiming/failing them are all separate and don't affect each other
1113         let chanmon_cfgs = create_chanmon_cfgs(6);
1114         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1115         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1116         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1117
1118         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1119         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1120         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1121         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1122         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1123         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1124
1125         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1126
1127         *nodes[0].network_payment_count.borrow_mut() -= 1;
1128         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1129
1130         *nodes[0].network_payment_count.borrow_mut() -= 1;
1131         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1132
1133         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1134         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1135         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1136 }
1137
1138 #[test]
1139 fn test_duplicate_htlc_different_direction_onchain() {
1140         // Test that ChannelMonitor doesn't generate 2 preimage txn
1141         // when we have 2 HTLCs with same preimage that go across a node
1142         // in opposite directions, even with the same payment secret.
1143         let chanmon_cfgs = create_chanmon_cfgs(2);
1144         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1145         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1146         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1147
1148         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1149
1150         // balancing
1151         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1152
1153         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1154
1155         let (route, _, _, _) = get_route_and_payment_hash!(nodes[1], nodes[0], 800_000);
1156         let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
1157         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1158
1159         // Provide preimage to node 0 by claiming payment
1160         nodes[0].node.claim_funds(payment_preimage);
1161         check_added_monitors!(nodes[0], 1);
1162
1163         // Broadcast node 1 commitment txn
1164         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1165
1166         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1167         let mut has_both_htlcs = 0; // check htlcs match ones committed
1168         for outp in remote_txn[0].output.iter() {
1169                 if outp.value == 800_000 / 1000 {
1170                         has_both_htlcs += 1;
1171                 } else if outp.value == 900_000 / 1000 {
1172                         has_both_htlcs += 1;
1173                 }
1174         }
1175         assert_eq!(has_both_htlcs, 2);
1176
1177         mine_transaction(&nodes[0], &remote_txn[0]);
1178         check_added_monitors!(nodes[0], 1);
1179         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
1180         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
1181
1182         // Check we only broadcast 1 timeout tx
1183         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1184         assert_eq!(claim_txn.len(), 8);
1185         assert_eq!(claim_txn[1], claim_txn[4]);
1186         assert_eq!(claim_txn[2], claim_txn[5]);
1187         check_spends!(claim_txn[1], chan_1.3);
1188         check_spends!(claim_txn[2], claim_txn[1]);
1189         check_spends!(claim_txn[7], claim_txn[1]);
1190
1191         assert_eq!(claim_txn[0].input.len(), 1);
1192         assert_eq!(claim_txn[3].input.len(), 1);
1193         assert_eq!(claim_txn[0].input[0].previous_output, claim_txn[3].input[0].previous_output);
1194
1195         assert_eq!(claim_txn[0].input.len(), 1);
1196         assert_eq!(claim_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1197         check_spends!(claim_txn[0], remote_txn[0]);
1198         assert_eq!(remote_txn[0].output[claim_txn[0].input[0].previous_output.vout as usize].value, 800);
1199         assert_eq!(claim_txn[6].input.len(), 1);
1200         assert_eq!(claim_txn[6].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1201         check_spends!(claim_txn[6], remote_txn[0]);
1202         assert_eq!(remote_txn[0].output[claim_txn[6].input[0].previous_output.vout as usize].value, 900);
1203
1204         let events = nodes[0].node.get_and_clear_pending_msg_events();
1205         assert_eq!(events.len(), 3);
1206         for e in events {
1207                 match e {
1208                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1209                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1210                                 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1211                                 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1212                         },
1213                         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, .. } } => {
1214                                 assert!(update_add_htlcs.is_empty());
1215                                 assert!(update_fail_htlcs.is_empty());
1216                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1217                                 assert!(update_fail_malformed_htlcs.is_empty());
1218                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1219                         },
1220                         _ => panic!("Unexpected event"),
1221                 }
1222         }
1223 }
1224
1225 #[test]
1226 fn test_basic_channel_reserve() {
1227         let chanmon_cfgs = create_chanmon_cfgs(2);
1228         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1229         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1230         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1231         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1232
1233         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1234         let channel_reserve = chan_stat.channel_reserve_msat;
1235
1236         // The 2* and +1 are for the fee spike reserve.
1237         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1238         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1239         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], max_can_send + 1);
1240         let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).err().unwrap();
1241         match err {
1242                 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1243                         match &fails[0] {
1244                                 &APIError::ChannelUnavailable{ref err} =>
1245                                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1246                                 _ => panic!("Unexpected error variant"),
1247                         }
1248                 },
1249                 _ => panic!("Unexpected error variant"),
1250         }
1251         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1252         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);
1253
1254         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1255 }
1256
1257 #[test]
1258 fn test_fee_spike_violation_fails_htlc() {
1259         let chanmon_cfgs = create_chanmon_cfgs(2);
1260         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1261         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1262         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1263         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1264
1265         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1266         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1267         let secp_ctx = Secp256k1::new();
1268         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1269
1270         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1271
1272         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1273         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height, &None).unwrap();
1274         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1275         let msg = msgs::UpdateAddHTLC {
1276                 channel_id: chan.2,
1277                 htlc_id: 0,
1278                 amount_msat: htlc_msat,
1279                 payment_hash: payment_hash,
1280                 cltv_expiry: htlc_cltv,
1281                 onion_routing_packet: onion_packet,
1282         };
1283
1284         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1285
1286         // Now manually create the commitment_signed message corresponding to the update_add
1287         // nodes[0] just sent. In the code for construction of this message, "local" refers
1288         // to the sender of the message, and "remote" refers to the receiver.
1289
1290         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1291
1292         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1293
1294         // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1295         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1296         let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point, local_funding) = {
1297                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1298                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1299                 let chan_signer = local_chan.get_signer();
1300                 // Make the signer believe we validated another commitment, so we can release the secret
1301                 chan_signer.get_enforcement_state().last_holder_commitment -= 1;
1302
1303                 let pubkeys = chan_signer.pubkeys();
1304                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1305                  chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1306                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx),
1307                  chan_signer.pubkeys().funding_pubkey)
1308         };
1309         let (remote_delayed_payment_basepoint, remote_htlc_basepoint, remote_point, remote_funding) = {
1310                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1311                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1312                 let chan_signer = remote_chan.get_signer();
1313                 let pubkeys = chan_signer.pubkeys();
1314                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1315                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx),
1316                  chan_signer.pubkeys().funding_pubkey)
1317         };
1318
1319         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1320         let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1321                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1322
1323         // Build the remote commitment transaction so we can sign it, and then later use the
1324         // signature for the commitment_signed message.
1325         let local_chan_balance = 1313;
1326
1327         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1328                 offered: false,
1329                 amount_msat: 3460001,
1330                 cltv_expiry: htlc_cltv,
1331                 payment_hash,
1332                 transaction_output_index: Some(1),
1333         };
1334
1335         let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1336
1337         let res = {
1338                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1339                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1340                 let local_chan_signer = local_chan.get_signer();
1341                 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1342                         commitment_number,
1343                         95000,
1344                         local_chan_balance,
1345                         false, local_funding, remote_funding,
1346                         commit_tx_keys.clone(),
1347                         feerate_per_kw,
1348                         &mut vec![(accepted_htlc_info, ())],
1349                         &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1350                 );
1351                 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1352         };
1353
1354         let commit_signed_msg = msgs::CommitmentSigned {
1355                 channel_id: chan.2,
1356                 signature: res.0,
1357                 htlc_signatures: res.1
1358         };
1359
1360         // Send the commitment_signed message to the nodes[1].
1361         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1362         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1363
1364         // Send the RAA to nodes[1].
1365         let raa_msg = msgs::RevokeAndACK {
1366                 channel_id: chan.2,
1367                 per_commitment_secret: local_secret,
1368                 next_per_commitment_point: next_local_point
1369         };
1370         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1371
1372         let events = nodes[1].node.get_and_clear_pending_msg_events();
1373         assert_eq!(events.len(), 1);
1374         // Make sure the HTLC failed in the way we expect.
1375         match events[0] {
1376                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1377                         assert_eq!(update_fail_htlcs.len(), 1);
1378                         update_fail_htlcs[0].clone()
1379                 },
1380                 _ => panic!("Unexpected event"),
1381         };
1382         nodes[1].logger.assert_log("lightning::ln::channel".to_string(),
1383                 format!("Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", ::hex::encode(raa_msg.channel_id)), 1);
1384
1385         check_added_monitors!(nodes[1], 2);
1386 }
1387
1388 #[test]
1389 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1390         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1391         // Set the fee rate for the channel very high, to the point where the fundee
1392         // sending any above-dust amount would result in a channel reserve violation.
1393         // In this test we check that we would be prevented from sending an HTLC in
1394         // this situation.
1395         let feerate_per_kw = 253;
1396         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1397         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1398         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1399         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1400         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1401
1402         let mut push_amt = 100_000_000;
1403         push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000 * 1000;
1404         push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1405
1406         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, push_amt, InitFeatures::known(), InitFeatures::known());
1407
1408         // Sending exactly enough to hit the reserve amount should be accepted
1409         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], 1_000_000);
1410
1411         // However one more HTLC should be significantly over the reserve amount and fail.
1412         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1_000_000);
1413         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1414                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1415         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1416         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);
1417 }
1418
1419 #[test]
1420 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1421         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1422         // Set the fee rate for the channel very high, to the point where the funder
1423         // receiving 1 update_add_htlc would result in them closing the channel due
1424         // to channel reserve violation. This close could also happen if the fee went
1425         // up a more realistic amount, but many HTLCs were outstanding at the time of
1426         // the update_add_htlc.
1427         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1428         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1429         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1430         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1431         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1432         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1433
1434         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1435         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1436         let secp_ctx = Secp256k1::new();
1437         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1438         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1439         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1440         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height, &None).unwrap();
1441         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1442         let msg = msgs::UpdateAddHTLC {
1443                 channel_id: chan.2,
1444                 htlc_id: 1,
1445                 amount_msat: htlc_msat + 1,
1446                 payment_hash: payment_hash,
1447                 cltv_expiry: htlc_cltv,
1448                 onion_routing_packet: onion_packet,
1449         };
1450
1451         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1452         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1453         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);
1454         assert_eq!(nodes[0].node.list_channels().len(), 0);
1455         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1456         assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1457         check_added_monitors!(nodes[0], 1);
1458         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() });
1459 }
1460
1461 #[test]
1462 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1463         // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1464         // calculating our commitment transaction fee (this was previously broken).
1465         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1466         let feerate_per_kw = 253;
1467         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1468         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1469
1470         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1471         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1472         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1473
1474         // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1475         // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1476         // transaction fee with 0 HTLCs (183 sats)).
1477         let mut push_amt = 100_000_000;
1478         push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT) / 1000 * 1000;
1479         push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1480         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, push_amt, InitFeatures::known(), InitFeatures::known());
1481
1482         let dust_amt = crate::ln::channel::MIN_CHAN_DUST_LIMIT_SATOSHIS * 1000
1483                 + feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000 * 1000 - 1;
1484         // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1485         // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1486         // commitment transaction fee.
1487         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1488
1489         // One more than the dust amt should fail, however.
1490         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], dust_amt + 1);
1491         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1492                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1493 }
1494
1495 #[test]
1496 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1497         // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1498         // calculating our counterparty's commitment transaction fee (this was previously broken).
1499         let chanmon_cfgs = create_chanmon_cfgs(2);
1500         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1501         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1502         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1503         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1504
1505         let payment_amt = 46000; // Dust amount
1506         // In the previous code, these first four payments would succeed.
1507         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1508         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1509         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1510         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1511
1512         // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1513         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1514         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1515         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1516         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1517         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1518
1519         // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1520         // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1521         // transaction fee and therefore perceived this next payment as a channel reserve violation.
1522         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1523 }
1524
1525 #[test]
1526 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1527         let chanmon_cfgs = create_chanmon_cfgs(3);
1528         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1529         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1530         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1531         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1532         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1533
1534         let feemsat = 239;
1535         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1536         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1537         let feerate = get_feerate!(nodes[0], chan.2);
1538
1539         // Add a 2* and +1 for the fee spike reserve.
1540         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1541         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;
1542         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1543
1544         // Add a pending HTLC.
1545         let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1546         let payment_event_1 = {
1547                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1548                 check_added_monitors!(nodes[0], 1);
1549
1550                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1551                 assert_eq!(events.len(), 1);
1552                 SendEvent::from_event(events.remove(0))
1553         };
1554         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1555
1556         // Attempt to trigger a channel reserve violation --> payment failure.
1557         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1558         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;
1559         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1560         let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1561
1562         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1563         let secp_ctx = Secp256k1::new();
1564         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1565         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1566         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1567         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height, &None).unwrap();
1568         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1569         let msg = msgs::UpdateAddHTLC {
1570                 channel_id: chan.2,
1571                 htlc_id: 1,
1572                 amount_msat: htlc_msat + 1,
1573                 payment_hash: our_payment_hash_1,
1574                 cltv_expiry: htlc_cltv,
1575                 onion_routing_packet: onion_packet,
1576         };
1577
1578         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1579         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1580         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1581         assert_eq!(nodes[1].node.list_channels().len(), 1);
1582         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1583         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1584         check_added_monitors!(nodes[1], 1);
1585         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Remote HTLC add would put them under remote reserve value".to_string() });
1586 }
1587
1588 #[test]
1589 fn test_inbound_outbound_capacity_is_not_zero() {
1590         let chanmon_cfgs = create_chanmon_cfgs(2);
1591         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1592         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1593         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1594         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1595         let channels0 = node_chanmgrs[0].list_channels();
1596         let channels1 = node_chanmgrs[1].list_channels();
1597         assert_eq!(channels0.len(), 1);
1598         assert_eq!(channels1.len(), 1);
1599
1600         let reserve = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100000);
1601         assert_eq!(channels0[0].inbound_capacity_msat, 95000000 - reserve*1000);
1602         assert_eq!(channels1[0].outbound_capacity_msat, 95000000 - reserve*1000);
1603
1604         assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1605         assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1606 }
1607
1608 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1609         (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1610 }
1611
1612 #[test]
1613 fn test_channel_reserve_holding_cell_htlcs() {
1614         let chanmon_cfgs = create_chanmon_cfgs(3);
1615         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1616         // When this test was written, the default base fee floated based on the HTLC count.
1617         // It is now fixed, so we simply set the fee to the expected value here.
1618         let mut config = test_default_channel_config();
1619         config.channel_options.forwarding_fee_base_msat = 239;
1620         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
1621         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1622         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1623         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1624
1625         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1626         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1627
1628         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1629         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1630
1631         macro_rules! expect_forward {
1632                 ($node: expr) => {{
1633                         let mut events = $node.node.get_and_clear_pending_msg_events();
1634                         assert_eq!(events.len(), 1);
1635                         check_added_monitors!($node, 1);
1636                         let payment_event = SendEvent::from_event(events.remove(0));
1637                         payment_event
1638                 }}
1639         }
1640
1641         let feemsat = 239; // set above
1642         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1643         let feerate = get_feerate!(nodes[0], chan_1.2);
1644
1645         let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1646
1647         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1648         {
1649                 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1650                 route.paths[0].last_mut().unwrap().fee_msat += 1;
1651                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1652                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1653                         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)));
1654                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1655                 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);
1656         }
1657
1658         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1659         // nodes[0]'s wealth
1660         loop {
1661                 let amt_msat = recv_value_0 + total_fee_msat;
1662                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1663                 // Also, ensure that each payment has enough to be over the dust limit to
1664                 // ensure it'll be included in each commit tx fee calculation.
1665                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1666                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1667                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1668                         break;
1669                 }
1670                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1671
1672                 let (stat01_, stat11_, stat12_, stat22_) = (
1673                         get_channel_value_stat!(nodes[0], chan_1.2),
1674                         get_channel_value_stat!(nodes[1], chan_1.2),
1675                         get_channel_value_stat!(nodes[1], chan_2.2),
1676                         get_channel_value_stat!(nodes[2], chan_2.2),
1677                 );
1678
1679                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1680                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1681                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1682                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1683                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1684         }
1685
1686         // adding pending output.
1687         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1688         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1689         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1690         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1691         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1692         // cases where 1 msat over X amount will cause a payment failure, but anything less than
1693         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1694         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1695         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1696         // policy.
1697         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1698         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1699         let amt_msat_1 = recv_value_1 + total_fee_msat;
1700
1701         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);
1702         let payment_event_1 = {
1703                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1704                 check_added_monitors!(nodes[0], 1);
1705
1706                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1707                 assert_eq!(events.len(), 1);
1708                 SendEvent::from_event(events.remove(0))
1709         };
1710         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1711
1712         // channel reserve test with htlc pending output > 0
1713         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1714         {
1715                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
1716                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1717                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1718                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1719         }
1720
1721         // split the rest to test holding cell
1722         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1723         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
1724         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
1725         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
1726         {
1727                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1728                 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);
1729         }
1730
1731         // now see if they go through on both sides
1732         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);
1733         // but this will stuck in the holding cell
1734         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
1735         check_added_monitors!(nodes[0], 0);
1736         let events = nodes[0].node.get_and_clear_pending_events();
1737         assert_eq!(events.len(), 0);
1738
1739         // test with outbound holding cell amount > 0
1740         {
1741                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
1742                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1743                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1744                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1745                 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);
1746         }
1747
1748         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);
1749         // this will also stuck in the holding cell
1750         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
1751         check_added_monitors!(nodes[0], 0);
1752         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1753         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1754
1755         // flush the pending htlc
1756         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1757         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1758         check_added_monitors!(nodes[1], 1);
1759
1760         // the pending htlc should be promoted to committed
1761         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1762         check_added_monitors!(nodes[0], 1);
1763         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1764
1765         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1766         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1767         // No commitment_signed so get_event_msg's assert(len == 1) passes
1768         check_added_monitors!(nodes[0], 1);
1769
1770         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1771         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1772         check_added_monitors!(nodes[1], 1);
1773
1774         expect_pending_htlcs_forwardable!(nodes[1]);
1775
1776         let ref payment_event_11 = expect_forward!(nodes[1]);
1777         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1778         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1779
1780         expect_pending_htlcs_forwardable!(nodes[2]);
1781         expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
1782
1783         // flush the htlcs in the holding cell
1784         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1785         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1786         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1787         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1788         expect_pending_htlcs_forwardable!(nodes[1]);
1789
1790         let ref payment_event_3 = expect_forward!(nodes[1]);
1791         assert_eq!(payment_event_3.msgs.len(), 2);
1792         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1793         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1794
1795         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1796         expect_pending_htlcs_forwardable!(nodes[2]);
1797
1798         let events = nodes[2].node.get_and_clear_pending_events();
1799         assert_eq!(events.len(), 2);
1800         match events[0] {
1801                 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1802                         assert_eq!(our_payment_hash_21, *payment_hash);
1803                         assert_eq!(recv_value_21, amt);
1804                         match &purpose {
1805                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1806                                         assert!(payment_preimage.is_none());
1807                                         assert_eq!(our_payment_secret_21, *payment_secret);
1808                                 },
1809                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
1810                         }
1811                 },
1812                 _ => panic!("Unexpected event"),
1813         }
1814         match events[1] {
1815                 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1816                         assert_eq!(our_payment_hash_22, *payment_hash);
1817                         assert_eq!(recv_value_22, amt);
1818                         match &purpose {
1819                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1820                                         assert!(payment_preimage.is_none());
1821                                         assert_eq!(our_payment_secret_22, *payment_secret);
1822                                 },
1823                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
1824                         }
1825                 },
1826                 _ => panic!("Unexpected event"),
1827         }
1828
1829         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
1830         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
1831         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
1832
1833         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
1834         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
1835         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
1836
1837         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
1838         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);
1839         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1840         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1841         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
1842
1843         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1844         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
1845 }
1846
1847 #[test]
1848 fn channel_reserve_in_flight_removes() {
1849         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1850         // can send to its counterparty, but due to update ordering, the other side may not yet have
1851         // considered those HTLCs fully removed.
1852         // This tests that we don't count HTLCs which will not be included in the next remote
1853         // commitment transaction towards the reserve value (as it implies no commitment transaction
1854         // will be generated which violates the remote reserve value).
1855         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1856         // To test this we:
1857         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1858         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1859         //    you only consider the value of the first HTLC, it may not),
1860         //  * start routing a third HTLC from A to B,
1861         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1862         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1863         //  * deliver the first fulfill from B
1864         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1865         //    claim,
1866         //  * deliver A's response CS and RAA.
1867         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1868         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
1869         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1870         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1871         let chanmon_cfgs = create_chanmon_cfgs(2);
1872         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1873         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1874         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1875         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1876
1877         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1878         // Route the first two HTLCs.
1879         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1880         let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1881
1882         // Start routing the third HTLC (this is just used to get everyone in the right state).
1883         let (route, payment_hash_3, payment_preimage_3, payment_secret_3) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
1884         let send_1 = {
1885                 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
1886                 check_added_monitors!(nodes[0], 1);
1887                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1888                 assert_eq!(events.len(), 1);
1889                 SendEvent::from_event(events.remove(0))
1890         };
1891
1892         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1893         // initial fulfill/CS.
1894         assert!(nodes[1].node.claim_funds(payment_preimage_1));
1895         check_added_monitors!(nodes[1], 1);
1896         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1897
1898         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1899         // remove the second HTLC when we send the HTLC back from B to A.
1900         assert!(nodes[1].node.claim_funds(payment_preimage_2));
1901         check_added_monitors!(nodes[1], 1);
1902         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1903
1904         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
1905         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
1906         check_added_monitors!(nodes[0], 1);
1907         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1908         expect_payment_sent!(nodes[0], payment_preimage_1);
1909
1910         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
1911         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
1912         check_added_monitors!(nodes[1], 1);
1913         // B is already AwaitingRAA, so cant generate a CS here
1914         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1915
1916         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1917         check_added_monitors!(nodes[1], 1);
1918         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1919
1920         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1921         check_added_monitors!(nodes[0], 1);
1922         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1923
1924         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1925         check_added_monitors!(nodes[1], 1);
1926         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1927
1928         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1929         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1930         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1931         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1932         // on-chain as necessary).
1933         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
1934         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
1935         check_added_monitors!(nodes[0], 1);
1936         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1937         expect_payment_sent!(nodes[0], payment_preimage_2);
1938
1939         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1940         check_added_monitors!(nodes[1], 1);
1941         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1942
1943         expect_pending_htlcs_forwardable!(nodes[1]);
1944         expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
1945
1946         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1947         // resolve the second HTLC from A's point of view.
1948         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1949         check_added_monitors!(nodes[0], 1);
1950         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1951
1952         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1953         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1954         let (route, payment_hash_4, payment_preimage_4, payment_secret_4) = get_route_and_payment_hash!(nodes[1], nodes[0], 10000);
1955         let send_2 = {
1956                 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
1957                 check_added_monitors!(nodes[1], 1);
1958                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1959                 assert_eq!(events.len(), 1);
1960                 SendEvent::from_event(events.remove(0))
1961         };
1962
1963         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
1964         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
1965         check_added_monitors!(nodes[0], 1);
1966         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1967
1968         // Now just resolve all the outstanding messages/HTLCs for completeness...
1969
1970         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1971         check_added_monitors!(nodes[1], 1);
1972         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1973
1974         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1975         check_added_monitors!(nodes[1], 1);
1976
1977         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1978         check_added_monitors!(nodes[0], 1);
1979         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1980
1981         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1982         check_added_monitors!(nodes[1], 1);
1983         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1984
1985         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1986         check_added_monitors!(nodes[0], 1);
1987
1988         expect_pending_htlcs_forwardable!(nodes[0]);
1989         expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
1990
1991         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
1992         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
1993 }
1994
1995 #[test]
1996 fn channel_monitor_network_test() {
1997         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1998         // tests that ChannelMonitor is able to recover from various states.
1999         let chanmon_cfgs = create_chanmon_cfgs(5);
2000         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2001         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2002         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2003
2004         // Create some initial channels
2005         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2006         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2007         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2008         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2009
2010         // Make sure all nodes are at the same starting height
2011         connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2012         connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2013         connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2014         connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2015         connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2016
2017         // Rebalance the network a bit by relaying one payment through all the channels...
2018         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2019         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2020         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2021         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2022
2023         // Simple case with no pending HTLCs:
2024         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2025         check_added_monitors!(nodes[1], 1);
2026         check_closed_broadcast!(nodes[1], false);
2027         {
2028                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2029                 assert_eq!(node_txn.len(), 1);
2030                 mine_transaction(&nodes[0], &node_txn[0]);
2031                 check_added_monitors!(nodes[0], 1);
2032                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2033         }
2034         check_closed_broadcast!(nodes[0], true);
2035         assert_eq!(nodes[0].node.list_channels().len(), 0);
2036         assert_eq!(nodes[1].node.list_channels().len(), 1);
2037         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2038         check_closed_event!(nodes[1], 1, ClosureReason::DisconnectedPeer);
2039
2040         // One pending HTLC is discarded by the force-close:
2041         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2042
2043         // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2044         // broadcasted until we reach the timelock time).
2045         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2046         check_closed_broadcast!(nodes[1], false);
2047         check_added_monitors!(nodes[1], 1);
2048         {
2049                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2050                 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2051                 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2052                 mine_transaction(&nodes[2], &node_txn[0]);
2053                 check_added_monitors!(nodes[2], 1);
2054                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2055         }
2056         check_closed_broadcast!(nodes[2], true);
2057         assert_eq!(nodes[1].node.list_channels().len(), 0);
2058         assert_eq!(nodes[2].node.list_channels().len(), 1);
2059         check_closed_event!(nodes[1], 1, ClosureReason::DisconnectedPeer);
2060         check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
2061
2062         macro_rules! claim_funds {
2063                 ($node: expr, $prev_node: expr, $preimage: expr) => {
2064                         {
2065                                 assert!($node.node.claim_funds($preimage));
2066                                 check_added_monitors!($node, 1);
2067
2068                                 let events = $node.node.get_and_clear_pending_msg_events();
2069                                 assert_eq!(events.len(), 1);
2070                                 match events[0] {
2071                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2072                                                 assert!(update_add_htlcs.is_empty());
2073                                                 assert!(update_fail_htlcs.is_empty());
2074                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2075                                         },
2076                                         _ => panic!("Unexpected event"),
2077                                 };
2078                         }
2079                 }
2080         }
2081
2082         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2083         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2084         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2085         check_added_monitors!(nodes[2], 1);
2086         check_closed_broadcast!(nodes[2], false);
2087         let node2_commitment_txid;
2088         {
2089                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2090                 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2091                 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2092                 node2_commitment_txid = node_txn[0].txid();
2093
2094                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2095                 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2096                 mine_transaction(&nodes[3], &node_txn[0]);
2097                 check_added_monitors!(nodes[3], 1);
2098                 check_preimage_claim(&nodes[3], &node_txn);
2099         }
2100         check_closed_broadcast!(nodes[3], true);
2101         assert_eq!(nodes[2].node.list_channels().len(), 0);
2102         assert_eq!(nodes[3].node.list_channels().len(), 1);
2103         check_closed_event!(nodes[2], 1, ClosureReason::DisconnectedPeer);
2104         check_closed_event!(nodes[3], 1, ClosureReason::CommitmentTxConfirmed);
2105
2106         // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2107         // confusing us in the following tests.
2108         let chan_3_mon = nodes[3].chain_monitor.chain_monitor.remove_monitor(&OutPoint { txid: chan_3.3.txid(), index: 0 });
2109
2110         // One pending HTLC to time out:
2111         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2112         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2113         // buffer space).
2114
2115         let (close_chan_update_1, close_chan_update_2) = {
2116                 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2117                 let events = nodes[3].node.get_and_clear_pending_msg_events();
2118                 assert_eq!(events.len(), 2);
2119                 let close_chan_update_1 = match events[0] {
2120                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2121                                 msg.clone()
2122                         },
2123                         _ => panic!("Unexpected event"),
2124                 };
2125                 match events[1] {
2126                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2127                                 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2128                         },
2129                         _ => panic!("Unexpected event"),
2130                 }
2131                 check_added_monitors!(nodes[3], 1);
2132
2133                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2134                 {
2135                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2136                         node_txn.retain(|tx| {
2137                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2138                                         false
2139                                 } else { true }
2140                         });
2141                 }
2142
2143                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2144
2145                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2146                 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2147
2148                 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2149                 let events = nodes[4].node.get_and_clear_pending_msg_events();
2150                 assert_eq!(events.len(), 2);
2151                 let close_chan_update_2 = match events[0] {
2152                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2153                                 msg.clone()
2154                         },
2155                         _ => panic!("Unexpected event"),
2156                 };
2157                 match events[1] {
2158                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2159                                 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2160                         },
2161                         _ => panic!("Unexpected event"),
2162                 }
2163                 check_added_monitors!(nodes[4], 1);
2164                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2165
2166                 mine_transaction(&nodes[4], &node_txn[0]);
2167                 check_preimage_claim(&nodes[4], &node_txn);
2168                 (close_chan_update_1, close_chan_update_2)
2169         };
2170         nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2171         nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2172         assert_eq!(nodes[3].node.list_channels().len(), 0);
2173         assert_eq!(nodes[4].node.list_channels().len(), 0);
2174
2175         nodes[3].chain_monitor.chain_monitor.watch_channel(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon).unwrap();
2176         check_closed_event!(nodes[3], 1, ClosureReason::CommitmentTxConfirmed);
2177         check_closed_event!(nodes[4], 1, ClosureReason::CommitmentTxConfirmed);
2178 }
2179
2180 #[test]
2181 fn test_justice_tx() {
2182         // Test justice txn built on revoked HTLC-Success tx, against both sides
2183         let mut alice_config = UserConfig::default();
2184         alice_config.channel_options.announced_channel = true;
2185         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2186         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2187         let mut bob_config = UserConfig::default();
2188         bob_config.channel_options.announced_channel = true;
2189         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2190         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2191         let user_cfgs = [Some(alice_config), Some(bob_config)];
2192         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2193         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2194         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2195         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2196         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2197         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2198         // Create some new channels:
2199         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2200
2201         // A pending HTLC which will be revoked:
2202         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2203         // Get the will-be-revoked local txn from nodes[0]
2204         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2205         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2206         assert_eq!(revoked_local_txn[0].input.len(), 1);
2207         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2208         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2209         assert_eq!(revoked_local_txn[1].input.len(), 1);
2210         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2211         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2212         // Revoke the old state
2213         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2214
2215         {
2216                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2217                 {
2218                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2219                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2220                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2221
2222                         check_spends!(node_txn[0], revoked_local_txn[0]);
2223                         node_txn.swap_remove(0);
2224                         node_txn.truncate(1);
2225                 }
2226                 check_added_monitors!(nodes[1], 1);
2227                 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2228                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2229
2230                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2231                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2232                 // Verify broadcast of revoked HTLC-timeout
2233                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2234                 check_added_monitors!(nodes[0], 1);
2235                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2236                 // Broadcast revoked HTLC-timeout on node 1
2237                 mine_transaction(&nodes[1], &node_txn[1]);
2238                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2239         }
2240         get_announce_close_broadcast_events(&nodes, 0, 1);
2241
2242         assert_eq!(nodes[0].node.list_channels().len(), 0);
2243         assert_eq!(nodes[1].node.list_channels().len(), 0);
2244
2245         // We test justice_tx build by A on B's revoked HTLC-Success tx
2246         // Create some new channels:
2247         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2248         {
2249                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2250                 node_txn.clear();
2251         }
2252
2253         // A pending HTLC which will be revoked:
2254         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2255         // Get the will-be-revoked local txn from B
2256         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2257         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2258         assert_eq!(revoked_local_txn[0].input.len(), 1);
2259         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2260         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2261         // Revoke the old state
2262         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2263         {
2264                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2265                 {
2266                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2267                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2268                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2269
2270                         check_spends!(node_txn[0], revoked_local_txn[0]);
2271                         node_txn.swap_remove(0);
2272                 }
2273                 check_added_monitors!(nodes[0], 1);
2274                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2275
2276                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2277                 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2278                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2279                 check_added_monitors!(nodes[1], 1);
2280                 mine_transaction(&nodes[0], &node_txn[1]);
2281                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2282                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2283         }
2284         get_announce_close_broadcast_events(&nodes, 0, 1);
2285         assert_eq!(nodes[0].node.list_channels().len(), 0);
2286         assert_eq!(nodes[1].node.list_channels().len(), 0);
2287 }
2288
2289 #[test]
2290 fn revoked_output_claim() {
2291         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2292         // transaction is broadcast by its counterparty
2293         let chanmon_cfgs = create_chanmon_cfgs(2);
2294         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2295         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2296         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2297         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2298         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2299         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2300         assert_eq!(revoked_local_txn.len(), 1);
2301         // Only output is the full channel value back to nodes[0]:
2302         assert_eq!(revoked_local_txn[0].output.len(), 1);
2303         // Send a payment through, updating everyone's latest commitment txn
2304         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2305
2306         // Inform nodes[1] that nodes[0] broadcast a stale tx
2307         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2308         check_added_monitors!(nodes[1], 1);
2309         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2310         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2311         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2312
2313         check_spends!(node_txn[0], revoked_local_txn[0]);
2314         check_spends!(node_txn[1], chan_1.3);
2315
2316         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2317         mine_transaction(&nodes[0], &revoked_local_txn[0]);
2318         get_announce_close_broadcast_events(&nodes, 0, 1);
2319         check_added_monitors!(nodes[0], 1);
2320         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2321 }
2322
2323 #[test]
2324 fn claim_htlc_outputs_shared_tx() {
2325         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2326         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2327         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2328         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2329         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2330         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2331
2332         // Create some new channel:
2333         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2334
2335         // Rebalance the network to generate htlc in the two directions
2336         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2337         // 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
2338         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2339         let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2340
2341         // Get the will-be-revoked local txn from node[0]
2342         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2343         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2344         assert_eq!(revoked_local_txn[0].input.len(), 1);
2345         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2346         assert_eq!(revoked_local_txn[1].input.len(), 1);
2347         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2348         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2349         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2350
2351         //Revoke the old state
2352         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2353
2354         {
2355                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2356                 check_added_monitors!(nodes[0], 1);
2357                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2358                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2359                 check_added_monitors!(nodes[1], 1);
2360                 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2361                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2362                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2363
2364                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2365                 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment
2366
2367                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2368                 check_spends!(node_txn[0], revoked_local_txn[0]);
2369
2370                 let mut witness_lens = BTreeSet::new();
2371                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2372                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2373                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2374                 assert_eq!(witness_lens.len(), 3);
2375                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2376                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2377                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2378
2379                 // Next nodes[1] broadcasts its current local tx state:
2380                 assert_eq!(node_txn[1].input.len(), 1);
2381                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2382         }
2383         get_announce_close_broadcast_events(&nodes, 0, 1);
2384         assert_eq!(nodes[0].node.list_channels().len(), 0);
2385         assert_eq!(nodes[1].node.list_channels().len(), 0);
2386 }
2387
2388 #[test]
2389 fn claim_htlc_outputs_single_tx() {
2390         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2391         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2392         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2393         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2394         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2395         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2396
2397         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2398
2399         // Rebalance the network to generate htlc in the two directions
2400         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2401         // 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
2402         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2403         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2404         let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2405
2406         // Get the will-be-revoked local txn from node[0]
2407         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2408
2409         //Revoke the old state
2410         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2411
2412         {
2413                 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2414                 check_added_monitors!(nodes[0], 1);
2415                 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2416                 check_added_monitors!(nodes[1], 1);
2417                 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2418                 let mut events = nodes[0].node.get_and_clear_pending_events();
2419                 expect_pending_htlcs_forwardable_from_events!(nodes[0], events[0..1], true);
2420                 match events[1] {
2421                         Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
2422                         _ => panic!("Unexpected event"),
2423                 }
2424
2425                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2426                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2427
2428                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2429                 assert_eq!(node_txn.len(), 9);
2430                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2431                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2432                 // ChannelMonitor: bumped justice tx, after one increase, bumps on HTLC aren't generated not being substantial anymore, bump on revoked to_local isn't generated due to more room for expiration (2)
2433                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2434
2435                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2436                 assert_eq!(node_txn[0].input.len(), 1);
2437                 check_spends!(node_txn[0], chan_1.3);
2438                 assert_eq!(node_txn[1].input.len(), 1);
2439                 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2440                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2441                 check_spends!(node_txn[1], node_txn[0]);
2442
2443                 // Justice transactions are indices 1-2-4
2444                 assert_eq!(node_txn[2].input.len(), 1);
2445                 assert_eq!(node_txn[3].input.len(), 1);
2446                 assert_eq!(node_txn[4].input.len(), 1);
2447
2448                 check_spends!(node_txn[2], revoked_local_txn[0]);
2449                 check_spends!(node_txn[3], revoked_local_txn[0]);
2450                 check_spends!(node_txn[4], revoked_local_txn[0]);
2451
2452                 let mut witness_lens = BTreeSet::new();
2453                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2454                 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2455                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2456                 assert_eq!(witness_lens.len(), 3);
2457                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2458                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2459                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2460         }
2461         get_announce_close_broadcast_events(&nodes, 0, 1);
2462         assert_eq!(nodes[0].node.list_channels().len(), 0);
2463         assert_eq!(nodes[1].node.list_channels().len(), 0);
2464 }
2465
2466 #[test]
2467 fn test_htlc_on_chain_success() {
2468         // Test that in case of a unilateral close onchain, we detect the state of output and pass
2469         // the preimage backward accordingly. So here we test that ChannelManager is
2470         // broadcasting the right event to other nodes in payment path.
2471         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2472         // A --------------------> B ----------------------> C (preimage)
2473         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2474         // commitment transaction was broadcast.
2475         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2476         // towards B.
2477         // B should be able to claim via preimage if A then broadcasts its local tx.
2478         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2479         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2480         // PaymentSent event).
2481
2482         let chanmon_cfgs = create_chanmon_cfgs(3);
2483         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2484         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2485         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2486
2487         // Create some initial channels
2488         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2489         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2490
2491         // Ensure all nodes are at the same height
2492         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2493         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2494         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2495         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2496
2497         // Rebalance the network a bit by relaying one payment through all the channels...
2498         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2499         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2500
2501         let (our_payment_preimage, payment_hash_1, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2502         let (our_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2503
2504         // Broadcast legit commitment tx from C on B's chain
2505         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2506         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2507         assert_eq!(commitment_tx.len(), 1);
2508         check_spends!(commitment_tx[0], chan_2.3);
2509         nodes[2].node.claim_funds(our_payment_preimage);
2510         nodes[2].node.claim_funds(our_payment_preimage_2);
2511         check_added_monitors!(nodes[2], 2);
2512         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2513         assert!(updates.update_add_htlcs.is_empty());
2514         assert!(updates.update_fail_htlcs.is_empty());
2515         assert!(updates.update_fail_malformed_htlcs.is_empty());
2516         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2517
2518         mine_transaction(&nodes[2], &commitment_tx[0]);
2519         check_closed_broadcast!(nodes[2], true);
2520         check_added_monitors!(nodes[2], 1);
2521         check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
2522         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx, 2*htlc-success tx), ChannelMonitor : 2 (2 * HTLC-Success tx)
2523         assert_eq!(node_txn.len(), 5);
2524         assert_eq!(node_txn[0], node_txn[3]);
2525         assert_eq!(node_txn[1], node_txn[4]);
2526         assert_eq!(node_txn[2], commitment_tx[0]);
2527         check_spends!(node_txn[0], commitment_tx[0]);
2528         check_spends!(node_txn[1], commitment_tx[0]);
2529         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2530         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2531         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2532         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2533         assert_eq!(node_txn[0].lock_time, 0);
2534         assert_eq!(node_txn[1].lock_time, 0);
2535
2536         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2537         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2538         connect_block(&nodes[1], &Block { header, txdata: node_txn});
2539         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2540         {
2541                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2542                 assert_eq!(added_monitors.len(), 1);
2543                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2544                 added_monitors.clear();
2545         }
2546         let forwarded_events = nodes[1].node.get_and_clear_pending_events();
2547         assert_eq!(forwarded_events.len(), 3);
2548         match forwarded_events[0] {
2549                 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
2550                 _ => panic!("Unexpected event"),
2551         }
2552         if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[1] {
2553                 } else { panic!(); }
2554         if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[2] {
2555                 } else { panic!(); }
2556         let events = nodes[1].node.get_and_clear_pending_msg_events();
2557         {
2558                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2559                 assert_eq!(added_monitors.len(), 2);
2560                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2561                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2562                 added_monitors.clear();
2563         }
2564         assert_eq!(events.len(), 3);
2565         match events[0] {
2566                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2567                 _ => panic!("Unexpected event"),
2568         }
2569         match events[1] {
2570                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2571                 _ => panic!("Unexpected event"),
2572         }
2573
2574         match events[2] {
2575                 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, .. } } => {
2576                         assert!(update_add_htlcs.is_empty());
2577                         assert!(update_fail_htlcs.is_empty());
2578                         assert_eq!(update_fulfill_htlcs.len(), 1);
2579                         assert!(update_fail_malformed_htlcs.is_empty());
2580                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2581                 },
2582                 _ => panic!("Unexpected event"),
2583         };
2584         macro_rules! check_tx_local_broadcast {
2585                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2586                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2587                         assert_eq!(node_txn.len(), 3);
2588                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2589                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2590                         check_spends!(node_txn[1], $commitment_tx);
2591                         check_spends!(node_txn[2], $commitment_tx);
2592                         assert_ne!(node_txn[1].lock_time, 0);
2593                         assert_ne!(node_txn[2].lock_time, 0);
2594                         if $htlc_offered {
2595                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2596                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2597                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2598                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2599                         } else {
2600                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2601                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2602                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2603                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2604                         }
2605                         check_spends!(node_txn[0], $chan_tx);
2606                         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2607                         node_txn.clear();
2608                 } }
2609         }
2610         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2611         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2612         // timeout-claim of the output that nodes[2] just claimed via success.
2613         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2614
2615         // Broadcast legit commitment tx from A on B's chain
2616         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2617         let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2618         check_spends!(node_a_commitment_tx[0], chan_1.3);
2619         mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2620         check_closed_broadcast!(nodes[1], true);
2621         check_added_monitors!(nodes[1], 1);
2622         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2623         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2624         assert_eq!(node_txn.len(), 6); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 3 (HTLC-Success, 2* RBF bumps of above HTLC txn)
2625         let commitment_spend =
2626                 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2627                         check_spends!(node_txn[1], commitment_tx[0]);
2628                         check_spends!(node_txn[2], commitment_tx[0]);
2629                         assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2630                         &node_txn[0]
2631                 } else {
2632                         check_spends!(node_txn[0], commitment_tx[0]);
2633                         check_spends!(node_txn[1], commitment_tx[0]);
2634                         assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2635                         &node_txn[2]
2636                 };
2637
2638         check_spends!(commitment_spend, node_a_commitment_tx[0]);
2639         assert_eq!(commitment_spend.input.len(), 2);
2640         assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2641         assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2642         assert_eq!(commitment_spend.lock_time, 0);
2643         assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2644         check_spends!(node_txn[3], chan_1.3);
2645         assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2646         check_spends!(node_txn[4], node_txn[3]);
2647         check_spends!(node_txn[5], node_txn[3]);
2648         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2649         // we already checked the same situation with A.
2650
2651         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2652         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2653         connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
2654         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2655         check_closed_broadcast!(nodes[0], true);
2656         check_added_monitors!(nodes[0], 1);
2657         let events = nodes[0].node.get_and_clear_pending_events();
2658         assert_eq!(events.len(), 3);
2659         let mut first_claimed = false;
2660         for event in events {
2661                 match event {
2662                         Event::PaymentSent { payment_preimage, payment_hash, .. } => {
2663                                 if payment_preimage == our_payment_preimage && payment_hash == payment_hash_1 {
2664                                         assert!(!first_claimed);
2665                                         first_claimed = true;
2666                                 } else {
2667                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2668                                         assert_eq!(payment_hash, payment_hash_2);
2669                                 }
2670                         },
2671                         Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {},
2672                         _ => panic!("Unexpected event"),
2673                 }
2674         }
2675         check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0], chan_1.3);
2676 }
2677
2678 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2679         // Test that in case of a unilateral close onchain, we detect the state of output and
2680         // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2681         // broadcasting the right event to other nodes in payment path.
2682         // A ------------------> B ----------------------> C (timeout)
2683         //    B's commitment tx                 C's commitment tx
2684         //            \                                  \
2685         //         B's HTLC timeout tx               B's timeout tx
2686
2687         let chanmon_cfgs = create_chanmon_cfgs(3);
2688         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2689         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2690         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2691         *nodes[0].connect_style.borrow_mut() = connect_style;
2692         *nodes[1].connect_style.borrow_mut() = connect_style;
2693         *nodes[2].connect_style.borrow_mut() = connect_style;
2694
2695         // Create some intial channels
2696         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2697         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2698
2699         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2700         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2701         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2702
2703         let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2704
2705         // Broadcast legit commitment tx from C on B's chain
2706         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2707         check_spends!(commitment_tx[0], chan_2.3);
2708         nodes[2].node.fail_htlc_backwards(&payment_hash);
2709         check_added_monitors!(nodes[2], 0);
2710         expect_pending_htlcs_forwardable!(nodes[2]);
2711         check_added_monitors!(nodes[2], 1);
2712
2713         let events = nodes[2].node.get_and_clear_pending_msg_events();
2714         assert_eq!(events.len(), 1);
2715         match events[0] {
2716                 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, .. } } => {
2717                         assert!(update_add_htlcs.is_empty());
2718                         assert!(!update_fail_htlcs.is_empty());
2719                         assert!(update_fulfill_htlcs.is_empty());
2720                         assert!(update_fail_malformed_htlcs.is_empty());
2721                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2722                 },
2723                 _ => panic!("Unexpected event"),
2724         };
2725         mine_transaction(&nodes[2], &commitment_tx[0]);
2726         check_closed_broadcast!(nodes[2], true);
2727         check_added_monitors!(nodes[2], 1);
2728         check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
2729         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2730         assert_eq!(node_txn.len(), 1);
2731         check_spends!(node_txn[0], chan_2.3);
2732         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2733
2734         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2735         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2736         connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2737         mine_transaction(&nodes[1], &commitment_tx[0]);
2738         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2739         let timeout_tx;
2740         {
2741                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2742                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2743                 assert_eq!(node_txn[0], node_txn[3]);
2744                 assert_eq!(node_txn[1], node_txn[4]);
2745
2746                 check_spends!(node_txn[2], commitment_tx[0]);
2747                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2748
2749                 check_spends!(node_txn[0], chan_2.3);
2750                 check_spends!(node_txn[1], node_txn[0]);
2751                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2752                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2753
2754                 timeout_tx = node_txn[2].clone();
2755                 node_txn.clear();
2756         }
2757
2758         mine_transaction(&nodes[1], &timeout_tx);
2759         check_added_monitors!(nodes[1], 1);
2760         check_closed_broadcast!(nodes[1], true);
2761         {
2762                 // B will rebroadcast a fee-bumped timeout transaction here.
2763                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2764                 assert_eq!(node_txn.len(), 1);
2765                 check_spends!(node_txn[0], commitment_tx[0]);
2766         }
2767
2768         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2769         {
2770                 // B may rebroadcast its own holder commitment transaction here, as a safeguard against
2771                 // some incredibly unlikely partial-eclipse-attack scenarios. That said, because the
2772                 // original commitment_tx[0] (also spending chan_2.3) has reached ANTI_REORG_DELAY B really
2773                 // shouldn't broadcast anything here, and in some connect style scenarios we do not.
2774                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2775                 if node_txn.len() == 1 {
2776                         check_spends!(node_txn[0], chan_2.3);
2777                 } else {
2778                         assert_eq!(node_txn.len(), 0);
2779                 }
2780         }
2781
2782         expect_pending_htlcs_forwardable!(nodes[1]);
2783         check_added_monitors!(nodes[1], 1);
2784         let events = nodes[1].node.get_and_clear_pending_msg_events();
2785         assert_eq!(events.len(), 1);
2786         match events[0] {
2787                 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, .. } } => {
2788                         assert!(update_add_htlcs.is_empty());
2789                         assert!(!update_fail_htlcs.is_empty());
2790                         assert!(update_fulfill_htlcs.is_empty());
2791                         assert!(update_fail_malformed_htlcs.is_empty());
2792                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2793                 },
2794                 _ => panic!("Unexpected event"),
2795         };
2796
2797         // Broadcast legit commitment tx from B on A's chain
2798         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
2799         check_spends!(commitment_tx[0], chan_1.3);
2800
2801         mine_transaction(&nodes[0], &commitment_tx[0]);
2802         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2803
2804         check_closed_broadcast!(nodes[0], true);
2805         check_added_monitors!(nodes[0], 1);
2806         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2807         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 commitment tx, ChannelMonitor : 1 timeout tx
2808         assert_eq!(node_txn.len(), 2);
2809         check_spends!(node_txn[0], chan_1.3);
2810         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2811         check_spends!(node_txn[1], commitment_tx[0]);
2812         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2813 }
2814
2815 #[test]
2816 fn test_htlc_on_chain_timeout() {
2817         do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
2818         do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
2819         do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
2820 }
2821
2822 #[test]
2823 fn test_simple_commitment_revoked_fail_backward() {
2824         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2825         // and fail backward accordingly.
2826
2827         let chanmon_cfgs = create_chanmon_cfgs(3);
2828         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2829         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2830         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2831
2832         // Create some initial channels
2833         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2834         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2835
2836         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2837         // Get the will-be-revoked local txn from nodes[2]
2838         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2839         // Revoke the old state
2840         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
2841
2842         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2843
2844         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2845         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2846         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2847         check_added_monitors!(nodes[1], 1);
2848         check_closed_broadcast!(nodes[1], true);
2849
2850         expect_pending_htlcs_forwardable!(nodes[1]);
2851         check_added_monitors!(nodes[1], 1);
2852         let events = nodes[1].node.get_and_clear_pending_msg_events();
2853         assert_eq!(events.len(), 1);
2854         match events[0] {
2855                 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, .. } } => {
2856                         assert!(update_add_htlcs.is_empty());
2857                         assert_eq!(update_fail_htlcs.len(), 1);
2858                         assert!(update_fulfill_htlcs.is_empty());
2859                         assert!(update_fail_malformed_htlcs.is_empty());
2860                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2861
2862                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2863                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2864                         expect_payment_failed_with_update!(nodes[0], payment_hash, false, chan_2.0.contents.short_channel_id, true);
2865                 },
2866                 _ => panic!("Unexpected event"),
2867         }
2868 }
2869
2870 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2871         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2872         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2873         // commitment transaction anymore.
2874         // To do this, we have the peer which will broadcast a revoked commitment transaction send
2875         // a number of update_fail/commitment_signed updates without ever sending the RAA in
2876         // response to our commitment_signed. This is somewhat misbehavior-y, though not
2877         // technically disallowed and we should probably handle it reasonably.
2878         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2879         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2880         // transactions:
2881         // * Once we move it out of our holding cell/add it, we will immediately include it in a
2882         //   commitment_signed (implying it will be in the latest remote commitment transaction).
2883         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2884         //   and once they revoke the previous commitment transaction (allowing us to send a new
2885         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2886         let chanmon_cfgs = create_chanmon_cfgs(3);
2887         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2888         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2889         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2890
2891         // Create some initial channels
2892         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2893         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2894
2895         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 });
2896         // Get the will-be-revoked local txn from nodes[2]
2897         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2898         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2899         // Revoke the old state
2900         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
2901
2902         let value = if use_dust {
2903                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2904                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2905                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
2906         } else { 3000000 };
2907
2908         let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2909         let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2910         let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2911
2912         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
2913         expect_pending_htlcs_forwardable!(nodes[2]);
2914         check_added_monitors!(nodes[2], 1);
2915         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2916         assert!(updates.update_add_htlcs.is_empty());
2917         assert!(updates.update_fulfill_htlcs.is_empty());
2918         assert!(updates.update_fail_malformed_htlcs.is_empty());
2919         assert_eq!(updates.update_fail_htlcs.len(), 1);
2920         assert!(updates.update_fee.is_none());
2921         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2922         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2923         // Drop the last RAA from 3 -> 2
2924
2925         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
2926         expect_pending_htlcs_forwardable!(nodes[2]);
2927         check_added_monitors!(nodes[2], 1);
2928         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2929         assert!(updates.update_add_htlcs.is_empty());
2930         assert!(updates.update_fulfill_htlcs.is_empty());
2931         assert!(updates.update_fail_malformed_htlcs.is_empty());
2932         assert_eq!(updates.update_fail_htlcs.len(), 1);
2933         assert!(updates.update_fee.is_none());
2934         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2935         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2936         check_added_monitors!(nodes[1], 1);
2937         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2938         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2939         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2940         check_added_monitors!(nodes[2], 1);
2941
2942         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
2943         expect_pending_htlcs_forwardable!(nodes[2]);
2944         check_added_monitors!(nodes[2], 1);
2945         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2946         assert!(updates.update_add_htlcs.is_empty());
2947         assert!(updates.update_fulfill_htlcs.is_empty());
2948         assert!(updates.update_fail_malformed_htlcs.is_empty());
2949         assert_eq!(updates.update_fail_htlcs.len(), 1);
2950         assert!(updates.update_fee.is_none());
2951         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2952         // At this point first_payment_hash has dropped out of the latest two commitment
2953         // transactions that nodes[1] is tracking...
2954         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2955         check_added_monitors!(nodes[1], 1);
2956         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2957         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2958         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2959         check_added_monitors!(nodes[2], 1);
2960
2961         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2962         // on nodes[2]'s RAA.
2963         let (route, fourth_payment_hash, _, fourth_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[2], 1000000);
2964         nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
2965         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2966         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2967         check_added_monitors!(nodes[1], 0);
2968
2969         if deliver_bs_raa {
2970                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
2971                 // One monitor for the new revocation preimage, no second on as we won't generate a new
2972                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2973                 check_added_monitors!(nodes[1], 1);
2974                 let events = nodes[1].node.get_and_clear_pending_events();
2975                 assert_eq!(events.len(), 1);
2976                 match events[0] {
2977                         Event::PendingHTLCsForwardable { .. } => { },
2978                         _ => panic!("Unexpected event"),
2979                 };
2980                 // Deliberately don't process the pending fail-back so they all fail back at once after
2981                 // block connection just like the !deliver_bs_raa case
2982         }
2983
2984         let mut failed_htlcs = HashSet::new();
2985         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2986
2987         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2988         check_added_monitors!(nodes[1], 1);
2989         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2990
2991         let events = nodes[1].node.get_and_clear_pending_events();
2992         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
2993         match events[0] {
2994                 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => { },
2995                 _ => panic!("Unexepected event"),
2996         }
2997         match events[1] {
2998                 Event::PaymentPathFailed { ref payment_hash, .. } => {
2999                         assert_eq!(*payment_hash, fourth_payment_hash);
3000                 },
3001                 _ => panic!("Unexpected event"),
3002         }
3003         if !deliver_bs_raa {
3004                 match events[2] {
3005                         Event::PendingHTLCsForwardable { .. } => { },
3006                         _ => panic!("Unexpected event"),
3007                 };
3008         }
3009         nodes[1].node.process_pending_htlc_forwards();
3010         check_added_monitors!(nodes[1], 1);
3011
3012         let events = nodes[1].node.get_and_clear_pending_msg_events();
3013         assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3014         match events[if deliver_bs_raa { 1 } else { 0 }] {
3015                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3016                 _ => panic!("Unexpected event"),
3017         }
3018         match events[if deliver_bs_raa { 2 } else { 1 }] {
3019                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3020                         assert_eq!(channel_id, chan_2.2);
3021                         assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3022                 },
3023                 _ => panic!("Unexpected event"),
3024         }
3025         if deliver_bs_raa {
3026                 match events[0] {
3027                         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, .. } } => {
3028                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3029                                 assert_eq!(update_add_htlcs.len(), 1);
3030                                 assert!(update_fulfill_htlcs.is_empty());
3031                                 assert!(update_fail_htlcs.is_empty());
3032                                 assert!(update_fail_malformed_htlcs.is_empty());
3033                         },
3034                         _ => panic!("Unexpected event"),
3035                 }
3036         }
3037         match events[if deliver_bs_raa { 3 } else { 2 }] {
3038                 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, .. } } => {
3039                         assert!(update_add_htlcs.is_empty());
3040                         assert_eq!(update_fail_htlcs.len(), 3);
3041                         assert!(update_fulfill_htlcs.is_empty());
3042                         assert!(update_fail_malformed_htlcs.is_empty());
3043                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3044
3045                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3046                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3047                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3048
3049                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3050
3051                         let events = nodes[0].node.get_and_clear_pending_events();
3052                         assert_eq!(events.len(), 3);
3053                         match events[0] {
3054                                 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest: _, ref network_update, .. } => {
3055                                         assert!(failed_htlcs.insert(payment_hash.0));
3056                                         // If we delivered B's RAA we got an unknown preimage error, not something
3057                                         // that we should update our routing table for.
3058                                         if !deliver_bs_raa {
3059                                                 assert!(network_update.is_some());
3060                                         }
3061                                 },
3062                                 _ => panic!("Unexpected event"),
3063                         }
3064                         match events[1] {
3065                                 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest: _, ref network_update, .. } => {
3066                                         assert!(failed_htlcs.insert(payment_hash.0));
3067                                         assert!(network_update.is_some());
3068                                 },
3069                                 _ => panic!("Unexpected event"),
3070                         }
3071                         match events[2] {
3072                                 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest: _, ref network_update, .. } => {
3073                                         assert!(failed_htlcs.insert(payment_hash.0));
3074                                         assert!(network_update.is_some());
3075                                 },
3076                                 _ => panic!("Unexpected event"),
3077                         }
3078                 },
3079                 _ => panic!("Unexpected event"),
3080         }
3081
3082         assert!(failed_htlcs.contains(&first_payment_hash.0));
3083         assert!(failed_htlcs.contains(&second_payment_hash.0));
3084         assert!(failed_htlcs.contains(&third_payment_hash.0));
3085 }
3086
3087 #[test]
3088 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3089         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3090         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3091         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3092         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3093 }
3094
3095 #[test]
3096 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3097         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3098         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3099         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3100         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3101 }
3102
3103 #[test]
3104 fn fail_backward_pending_htlc_upon_channel_failure() {
3105         let chanmon_cfgs = create_chanmon_cfgs(2);
3106         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3107         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3108         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3109         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3110
3111         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3112         {
3113                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 50_000);
3114                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3115                 check_added_monitors!(nodes[0], 1);
3116
3117                 let payment_event = {
3118                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3119                         assert_eq!(events.len(), 1);
3120                         SendEvent::from_event(events.remove(0))
3121                 };
3122                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3123                 assert_eq!(payment_event.msgs.len(), 1);
3124         }
3125
3126         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3127         let (route, failed_payment_hash, _, failed_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 50_000);
3128         {
3129                 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3130                 check_added_monitors!(nodes[0], 0);
3131
3132                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3133         }
3134
3135         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3136         {
3137                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 50_000);
3138
3139                 let secp_ctx = Secp256k1::new();
3140                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3141                 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3142                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height, &None).unwrap();
3143                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3144                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3145
3146                 // Send a 0-msat update_add_htlc to fail the channel.
3147                 let update_add_htlc = msgs::UpdateAddHTLC {
3148                         channel_id: chan.2,
3149                         htlc_id: 0,
3150                         amount_msat: 0,
3151                         payment_hash,
3152                         cltv_expiry,
3153                         onion_routing_packet,
3154                 };
3155                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3156         }
3157         let events = nodes[0].node.get_and_clear_pending_events();
3158         assert_eq!(events.len(), 2);
3159         // Check that Alice fails backward the pending HTLC from the second payment.
3160         match events[0] {
3161                 Event::PaymentPathFailed { payment_hash, .. } => {
3162                         assert_eq!(payment_hash, failed_payment_hash);
3163                 },
3164                 _ => panic!("Unexpected event"),
3165         }
3166         match events[1] {
3167                 Event::ChannelClosed { reason: ClosureReason::ProcessingError { ref err }, .. } => {
3168                         assert_eq!(err, "Remote side tried to send a 0-msat HTLC");
3169                 },
3170                 _ => panic!("Unexpected event {:?}", events[1]),
3171         }
3172         check_closed_broadcast!(nodes[0], true);
3173         check_added_monitors!(nodes[0], 1);
3174 }
3175
3176 #[test]
3177 fn test_htlc_ignore_latest_remote_commitment() {
3178         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3179         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3180         let chanmon_cfgs = create_chanmon_cfgs(2);
3181         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3182         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3183         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3184         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3185
3186         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3187         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3188         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3189         check_closed_broadcast!(nodes[0], true);
3190         check_added_monitors!(nodes[0], 1);
3191         check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
3192
3193         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3194         assert_eq!(node_txn.len(), 3);
3195         assert_eq!(node_txn[0], node_txn[1]);
3196
3197         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3198         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3199         check_closed_broadcast!(nodes[1], true);
3200         check_added_monitors!(nodes[1], 1);
3201         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
3202
3203         // Duplicate the connect_block call since this may happen due to other listeners
3204         // registering new transactions
3205         header.prev_blockhash = header.block_hash();
3206         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3207 }
3208
3209 #[test]
3210 fn test_force_close_fail_back() {
3211         // Check which HTLCs are failed-backwards on channel force-closure
3212         let chanmon_cfgs = create_chanmon_cfgs(3);
3213         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3214         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3215         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3216         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3217         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3218
3219         let (route, our_payment_hash, our_payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
3220
3221         let mut payment_event = {
3222                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3223                 check_added_monitors!(nodes[0], 1);
3224
3225                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3226                 assert_eq!(events.len(), 1);
3227                 SendEvent::from_event(events.remove(0))
3228         };
3229
3230         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3231         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3232
3233         expect_pending_htlcs_forwardable!(nodes[1]);
3234
3235         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3236         assert_eq!(events_2.len(), 1);
3237         payment_event = SendEvent::from_event(events_2.remove(0));
3238         assert_eq!(payment_event.msgs.len(), 1);
3239
3240         check_added_monitors!(nodes[1], 1);
3241         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3242         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3243         check_added_monitors!(nodes[2], 1);
3244         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3245
3246         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3247         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3248         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3249
3250         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3251         check_closed_broadcast!(nodes[2], true);
3252         check_added_monitors!(nodes[2], 1);
3253         check_closed_event!(nodes[2], 1, ClosureReason::HolderForceClosed);
3254         let tx = {
3255                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3256                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3257                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3258                 // back to nodes[1] upon timeout otherwise.
3259                 assert_eq!(node_txn.len(), 1);
3260                 node_txn.remove(0)
3261         };
3262
3263         mine_transaction(&nodes[1], &tx);
3264
3265         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3266         check_closed_broadcast!(nodes[1], true);
3267         check_added_monitors!(nodes[1], 1);
3268         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
3269
3270         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3271         {
3272                 get_monitor!(nodes[2], payment_event.commitment_msg.channel_id)
3273                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &node_cfgs[2].logger);
3274         }
3275         mine_transaction(&nodes[2], &tx);
3276         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3277         assert_eq!(node_txn.len(), 1);
3278         assert_eq!(node_txn[0].input.len(), 1);
3279         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3280         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3281         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3282
3283         check_spends!(node_txn[0], tx);
3284 }
3285
3286 #[test]
3287 fn test_dup_events_on_peer_disconnect() {
3288         // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3289         // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3290         // as we used to generate the event immediately upon receipt of the payment preimage in the
3291         // update_fulfill_htlc message.
3292
3293         let chanmon_cfgs = create_chanmon_cfgs(2);
3294         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3295         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3296         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3297         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3298
3299         let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3300
3301         assert!(nodes[1].node.claim_funds(payment_preimage));
3302         check_added_monitors!(nodes[1], 1);
3303         let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3304         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3305         expect_payment_sent!(nodes[0], payment_preimage);
3306
3307         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3308         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3309
3310         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3311         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3312 }
3313
3314 #[test]
3315 fn test_simple_peer_disconnect() {
3316         // Test that we can reconnect when there are no lost messages
3317         let chanmon_cfgs = create_chanmon_cfgs(3);
3318         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3319         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3320         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3321         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3322         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3323
3324         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3325         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3326         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3327
3328         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3329         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3330         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3331         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3332
3333         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3334         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3335         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3336
3337         let (payment_preimage_3, payment_hash_3, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000);
3338         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3339         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3340         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3341
3342         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3343         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3344
3345         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3346         fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_hash_5);
3347
3348         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3349         {
3350                 let events = nodes[0].node.get_and_clear_pending_events();
3351                 assert_eq!(events.len(), 2);
3352                 match events[0] {
3353                         Event::PaymentSent { payment_preimage, payment_hash, .. } => {
3354                                 assert_eq!(payment_preimage, payment_preimage_3);
3355                                 assert_eq!(payment_hash, payment_hash_3);
3356                         },
3357                         _ => panic!("Unexpected event"),
3358                 }
3359                 match events[1] {
3360                         Event::PaymentPathFailed { payment_hash, rejected_by_dest, .. } => {
3361                                 assert_eq!(payment_hash, payment_hash_5);
3362                                 assert!(rejected_by_dest);
3363                         },
3364                         _ => panic!("Unexpected event"),
3365                 }
3366         }
3367
3368         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3369         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3370 }
3371
3372 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken_lnd: bool) {
3373         // Test that we can reconnect when in-flight HTLC updates get dropped
3374         let chanmon_cfgs = create_chanmon_cfgs(2);
3375         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3376         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3377         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3378
3379         let mut as_funding_locked = None;
3380         if messages_delivered == 0 {
3381                 let (funding_locked, _, _) = create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3382                 as_funding_locked = Some(funding_locked);
3383                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3384                 // Note that we store it so that if we're running with `simulate_broken_lnd` we can deliver
3385                 // it before the channel_reestablish message.
3386         } else {
3387                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3388         }
3389
3390         let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
3391
3392         let payment_event = {
3393                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3394                 check_added_monitors!(nodes[0], 1);
3395
3396                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3397                 assert_eq!(events.len(), 1);
3398                 SendEvent::from_event(events.remove(0))
3399         };
3400         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3401
3402         if messages_delivered < 2 {
3403                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3404         } else {
3405                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3406                 if messages_delivered >= 3 {
3407                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3408                         check_added_monitors!(nodes[1], 1);
3409                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3410
3411                         if messages_delivered >= 4 {
3412                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3413                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3414                                 check_added_monitors!(nodes[0], 1);
3415
3416                                 if messages_delivered >= 5 {
3417                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3418                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3419                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3420                                         check_added_monitors!(nodes[0], 1);
3421
3422                                         if messages_delivered >= 6 {
3423                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3424                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3425                                                 check_added_monitors!(nodes[1], 1);
3426                                         }
3427                                 }
3428                         }
3429                 }
3430         }
3431
3432         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3433         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3434         if messages_delivered < 3 {
3435                 if simulate_broken_lnd {
3436                         // lnd has a long-standing bug where they send a funding_locked prior to a
3437                         // channel_reestablish if you reconnect prior to funding_locked time.
3438                         //
3439                         // Here we simulate that behavior, delivering a funding_locked immediately on
3440                         // reconnect. Note that we don't bother skipping the now-duplicate funding_locked sent
3441                         // in `reconnect_nodes` but we currently don't fail based on that.
3442                         //
3443                         // See-also <https://github.com/lightningnetwork/lnd/issues/4006>
3444                         nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding_locked.as_ref().unwrap().0);
3445                 }
3446                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3447                 // received on either side, both sides will need to resend them.
3448                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3449         } else if messages_delivered == 3 {
3450                 // nodes[0] still wants its RAA + commitment_signed
3451                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3452         } else if messages_delivered == 4 {
3453                 // nodes[0] still wants its commitment_signed
3454                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3455         } else if messages_delivered == 5 {
3456                 // nodes[1] still wants its final RAA
3457                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3458         } else if messages_delivered == 6 {
3459                 // Everything was delivered...
3460                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3461         }
3462
3463         let events_1 = nodes[1].node.get_and_clear_pending_events();
3464         assert_eq!(events_1.len(), 1);
3465         match events_1[0] {
3466                 Event::PendingHTLCsForwardable { .. } => { },
3467                 _ => panic!("Unexpected event"),
3468         };
3469
3470         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3471         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3472         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3473
3474         nodes[1].node.process_pending_htlc_forwards();
3475
3476         let events_2 = nodes[1].node.get_and_clear_pending_events();
3477         assert_eq!(events_2.len(), 1);
3478         match events_2[0] {
3479                 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
3480                         assert_eq!(payment_hash_1, *payment_hash);
3481                         assert_eq!(amt, 1000000);
3482                         match &purpose {
3483                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3484                                         assert!(payment_preimage.is_none());
3485                                         assert_eq!(payment_secret_1, *payment_secret);
3486                                 },
3487                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
3488                         }
3489                 },
3490                 _ => panic!("Unexpected event"),
3491         }
3492
3493         nodes[1].node.claim_funds(payment_preimage_1);
3494         check_added_monitors!(nodes[1], 1);
3495
3496         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3497         assert_eq!(events_3.len(), 1);
3498         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3499                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3500                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3501                         assert!(updates.update_add_htlcs.is_empty());
3502                         assert!(updates.update_fail_htlcs.is_empty());
3503                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3504                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3505                         assert!(updates.update_fee.is_none());
3506                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3507                 },
3508                 _ => panic!("Unexpected event"),
3509         };
3510
3511         if messages_delivered >= 1 {
3512                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3513
3514                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3515                 assert_eq!(events_4.len(), 1);
3516                 match events_4[0] {
3517                         Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
3518                                 assert_eq!(payment_preimage_1, *payment_preimage);
3519                                 assert_eq!(payment_hash_1, *payment_hash);
3520                         },
3521                         _ => panic!("Unexpected event"),
3522                 }
3523
3524                 if messages_delivered >= 2 {
3525                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3526                         check_added_monitors!(nodes[0], 1);
3527                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3528
3529                         if messages_delivered >= 3 {
3530                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3531                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3532                                 check_added_monitors!(nodes[1], 1);
3533
3534                                 if messages_delivered >= 4 {
3535                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3536                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3537                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3538                                         check_added_monitors!(nodes[1], 1);
3539
3540                                         if messages_delivered >= 5 {
3541                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3542                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3543                                                 check_added_monitors!(nodes[0], 1);
3544                                         }
3545                                 }
3546                         }
3547                 }
3548         }
3549
3550         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3551         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3552         if messages_delivered < 2 {
3553                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3554                 if messages_delivered < 1 {
3555                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3556                         assert_eq!(events_4.len(), 1);
3557                         match events_4[0] {
3558                                 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
3559                                         assert_eq!(payment_preimage_1, *payment_preimage);
3560                                         assert_eq!(payment_hash_1, *payment_hash);
3561                                 },
3562                                 _ => panic!("Unexpected event"),
3563                         }
3564                 } else {
3565                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3566                 }
3567         } else if messages_delivered == 2 {
3568                 // nodes[0] still wants its RAA + commitment_signed
3569                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3570         } else if messages_delivered == 3 {
3571                 // nodes[0] still wants its commitment_signed
3572                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3573         } else if messages_delivered == 4 {
3574                 // nodes[1] still wants its final RAA
3575                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3576         } else if messages_delivered == 5 {
3577                 // Everything was delivered...
3578                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3579         }
3580
3581         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3582         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3583         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3584
3585         // Channel should still work fine...
3586         let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
3587         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3588         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3589 }
3590
3591 #[test]
3592 fn test_drop_messages_peer_disconnect_a() {
3593         do_test_drop_messages_peer_disconnect(0, true);
3594         do_test_drop_messages_peer_disconnect(0, false);
3595         do_test_drop_messages_peer_disconnect(1, false);
3596         do_test_drop_messages_peer_disconnect(2, false);
3597 }
3598
3599 #[test]
3600 fn test_drop_messages_peer_disconnect_b() {
3601         do_test_drop_messages_peer_disconnect(3, false);
3602         do_test_drop_messages_peer_disconnect(4, false);
3603         do_test_drop_messages_peer_disconnect(5, false);
3604         do_test_drop_messages_peer_disconnect(6, false);
3605 }
3606
3607 #[test]
3608 fn test_funding_peer_disconnect() {
3609         // Test that we can lock in our funding tx while disconnected
3610         let chanmon_cfgs = create_chanmon_cfgs(2);
3611         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3612         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3613         let persister: test_utils::TestPersister;
3614         let new_chain_monitor: test_utils::TestChainMonitor;
3615         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3616         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3617         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3618
3619         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3620         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3621
3622         confirm_transaction(&nodes[0], &tx);
3623         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3624         let chan_id;
3625         assert_eq!(events_1.len(), 1);
3626         match events_1[0] {
3627                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3628                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3629                         chan_id = msg.channel_id;
3630                 },
3631                 _ => panic!("Unexpected event"),
3632         }
3633
3634         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3635
3636         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3637         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3638
3639         confirm_transaction(&nodes[1], &tx);
3640         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3641         assert_eq!(events_2.len(), 2);
3642         let funding_locked = match events_2[0] {
3643                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3644                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3645                         msg.clone()
3646                 },
3647                 _ => panic!("Unexpected event"),
3648         };
3649         let bs_announcement_sigs = match events_2[1] {
3650                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3651                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3652                         msg.clone()
3653                 },
3654                 _ => panic!("Unexpected event"),
3655         };
3656
3657         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3658
3659         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3660         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3661         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3662         assert_eq!(events_3.len(), 2);
3663         let as_announcement_sigs = match events_3[0] {
3664                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3665                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3666                         msg.clone()
3667                 },
3668                 _ => panic!("Unexpected event"),
3669         };
3670         let (as_announcement, as_update) = match events_3[1] {
3671                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3672                         (msg.clone(), update_msg.clone())
3673                 },
3674                 _ => panic!("Unexpected event"),
3675         };
3676
3677         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3678         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3679         assert_eq!(events_4.len(), 1);
3680         let (_, bs_update) = match events_4[0] {
3681                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3682                         (msg.clone(), update_msg.clone())
3683                 },
3684                 _ => panic!("Unexpected event"),
3685         };
3686
3687         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3688         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3689         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3690
3691         let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
3692         let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3693         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3694
3695         // Check that after deserialization and reconnection we can still generate an identical
3696         // channel_announcement from the cached signatures.
3697         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3698
3699         let nodes_0_serialized = nodes[0].node.encode();
3700         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3701         get_monitor!(nodes[0], chan_id).write(&mut chan_0_monitor_serialized).unwrap();
3702
3703         persister = test_utils::TestPersister::new();
3704         let keys_manager = &chanmon_cfgs[0].keys_manager;
3705         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), nodes[0].logger, node_cfgs[0].fee_estimator, &persister, keys_manager);
3706         nodes[0].chain_monitor = &new_chain_monitor;
3707         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3708         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3709                 &mut chan_0_monitor_read, keys_manager).unwrap();
3710         assert!(chan_0_monitor_read.is_empty());
3711
3712         let mut nodes_0_read = &nodes_0_serialized[..];
3713         let (_, nodes_0_deserialized_tmp) = {
3714                 let mut channel_monitors = HashMap::new();
3715                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3716                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3717                         default_config: UserConfig::default(),
3718                         keys_manager,
3719                         fee_estimator: node_cfgs[0].fee_estimator,
3720                         chain_monitor: nodes[0].chain_monitor,
3721                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3722                         logger: nodes[0].logger,
3723                         channel_monitors,
3724                 }).unwrap()
3725         };
3726         nodes_0_deserialized = nodes_0_deserialized_tmp;
3727         assert!(nodes_0_read.is_empty());
3728
3729         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
3730         nodes[0].node = &nodes_0_deserialized;
3731         check_added_monitors!(nodes[0], 1);
3732
3733         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3734
3735         // as_announcement should be re-generated exactly by broadcast_node_announcement.
3736         nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
3737         let msgs = nodes[0].node.get_and_clear_pending_msg_events();
3738         let mut found_announcement = false;
3739         for event in msgs.iter() {
3740                 match event {
3741                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
3742                                 if *msg == as_announcement { found_announcement = true; }
3743                         },
3744                         MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
3745                         _ => panic!("Unexpected event"),
3746                 }
3747         }
3748         assert!(found_announcement);
3749 }
3750
3751 #[test]
3752 fn test_drop_messages_peer_disconnect_dual_htlc() {
3753         // Test that we can handle reconnecting when both sides of a channel have pending
3754         // commitment_updates when we disconnect.
3755         let chanmon_cfgs = create_chanmon_cfgs(2);
3756         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3757         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3758         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3759         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3760
3761         let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3762
3763         // Now try to send a second payment which will fail to send
3764         let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
3765         nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
3766         check_added_monitors!(nodes[0], 1);
3767
3768         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3769         assert_eq!(events_1.len(), 1);
3770         match events_1[0] {
3771                 MessageSendEvent::UpdateHTLCs { .. } => {},
3772                 _ => panic!("Unexpected event"),
3773         }
3774
3775         assert!(nodes[1].node.claim_funds(payment_preimage_1));
3776         check_added_monitors!(nodes[1], 1);
3777
3778         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3779         assert_eq!(events_2.len(), 1);
3780         match events_2[0] {
3781                 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 } } => {
3782                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3783                         assert!(update_add_htlcs.is_empty());
3784                         assert_eq!(update_fulfill_htlcs.len(), 1);
3785                         assert!(update_fail_htlcs.is_empty());
3786                         assert!(update_fail_malformed_htlcs.is_empty());
3787                         assert!(update_fee.is_none());
3788
3789                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3790                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3791                         assert_eq!(events_3.len(), 1);
3792                         match events_3[0] {
3793                                 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
3794                                         assert_eq!(*payment_preimage, payment_preimage_1);
3795                                         assert_eq!(*payment_hash, payment_hash_1);
3796                                 },
3797                                 _ => panic!("Unexpected event"),
3798                         }
3799
3800                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3801                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3802                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3803                         check_added_monitors!(nodes[0], 1);
3804                 },
3805                 _ => panic!("Unexpected event"),
3806         }
3807
3808         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3809         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3810
3811         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3812         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3813         assert_eq!(reestablish_1.len(), 1);
3814         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3815         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3816         assert_eq!(reestablish_2.len(), 1);
3817
3818         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3819         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3820         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3821         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3822
3823         assert!(as_resp.0.is_none());
3824         assert!(bs_resp.0.is_none());
3825
3826         assert!(bs_resp.1.is_none());
3827         assert!(bs_resp.2.is_none());
3828
3829         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3830
3831         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3832         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3833         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3834         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3835         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3836         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3837         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3838         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3839         // No commitment_signed so get_event_msg's assert(len == 1) passes
3840         check_added_monitors!(nodes[1], 1);
3841
3842         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3843         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3844         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3845         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3846         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3847         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3848         assert!(bs_second_commitment_signed.update_fee.is_none());
3849         check_added_monitors!(nodes[1], 1);
3850
3851         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3852         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3853         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3854         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3855         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3856         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3857         assert!(as_commitment_signed.update_fee.is_none());
3858         check_added_monitors!(nodes[0], 1);
3859
3860         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3861         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3862         // No commitment_signed so get_event_msg's assert(len == 1) passes
3863         check_added_monitors!(nodes[0], 1);
3864
3865         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3866         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3867         // No commitment_signed so get_event_msg's assert(len == 1) passes
3868         check_added_monitors!(nodes[1], 1);
3869
3870         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3871         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3872         check_added_monitors!(nodes[1], 1);
3873
3874         expect_pending_htlcs_forwardable!(nodes[1]);
3875
3876         let events_5 = nodes[1].node.get_and_clear_pending_events();
3877         assert_eq!(events_5.len(), 1);
3878         match events_5[0] {
3879                 Event::PaymentReceived { ref payment_hash, ref purpose, .. } => {
3880                         assert_eq!(payment_hash_2, *payment_hash);
3881                         match &purpose {
3882                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3883                                         assert!(payment_preimage.is_none());
3884                                         assert_eq!(payment_secret_2, *payment_secret);
3885                                 },
3886                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
3887                         }
3888                 },
3889                 _ => panic!("Unexpected event"),
3890         }
3891
3892         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3893         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3894         check_added_monitors!(nodes[0], 1);
3895
3896         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3897 }
3898
3899 fn do_test_htlc_timeout(send_partial_mpp: bool) {
3900         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
3901         // to avoid our counterparty failing the channel.
3902         let chanmon_cfgs = create_chanmon_cfgs(2);
3903         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3904         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3905         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3906
3907         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3908
3909         let our_payment_hash = if send_partial_mpp {
3910                 let (route, our_payment_hash, _, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100000);
3911                 // Use the utility function send_payment_along_path to send the payment with MPP data which
3912                 // indicates there are more HTLCs coming.
3913                 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.
3914                 let payment_id = PaymentId([42; 32]);
3915                 nodes[0].node.send_payment_along_path(&route.paths[0], &route.payee, &our_payment_hash, &Some(payment_secret), 200000, cur_height, payment_id, &None).unwrap();
3916                 check_added_monitors!(nodes[0], 1);
3917                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3918                 assert_eq!(events.len(), 1);
3919                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
3920                 // hop should *not* yet generate any PaymentReceived event(s).
3921                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
3922                 our_payment_hash
3923         } else {
3924                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
3925         };
3926
3927         let mut block = Block {
3928                 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
3929                 txdata: vec![],
3930         };
3931         connect_block(&nodes[0], &block);
3932         connect_block(&nodes[1], &block);
3933         let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
3934         for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
3935                 block.header.prev_blockhash = block.block_hash();
3936                 connect_block(&nodes[0], &block);
3937                 connect_block(&nodes[1], &block);
3938         }
3939
3940         expect_pending_htlcs_forwardable!(nodes[1]);
3941
3942         check_added_monitors!(nodes[1], 1);
3943         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3944         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
3945         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
3946         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
3947         assert!(htlc_timeout_updates.update_fee.is_none());
3948
3949         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
3950         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
3951         // 100_000 msat as u64, followed by the height at which we failed back above
3952         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
3953         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
3954         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
3955 }
3956
3957 #[test]
3958 fn test_htlc_timeout() {
3959         do_test_htlc_timeout(true);
3960         do_test_htlc_timeout(false);
3961 }
3962
3963 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
3964         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
3965         let chanmon_cfgs = create_chanmon_cfgs(3);
3966         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3967         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3968         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3969         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3970         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3971
3972         // Make sure all nodes are at the same starting height
3973         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
3974         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
3975         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
3976
3977         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
3978         let (route, first_payment_hash, _, first_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[2], 100000);
3979         {
3980                 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
3981         }
3982         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
3983         check_added_monitors!(nodes[1], 1);
3984
3985         // Now attempt to route a second payment, which should be placed in the holding cell
3986         let sending_node = if forwarded_htlc { &nodes[0] } else { &nodes[1] };
3987         let (route, second_payment_hash, _, second_payment_secret) = get_route_and_payment_hash!(sending_node, nodes[2], 100000);
3988         sending_node.node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
3989         if forwarded_htlc {
3990                 check_added_monitors!(nodes[0], 1);
3991                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
3992                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3993                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3994                 expect_pending_htlcs_forwardable!(nodes[1]);
3995         }
3996         check_added_monitors!(nodes[1], 0);
3997
3998         connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
3999         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4000         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4001         connect_blocks(&nodes[1], 1);
4002
4003         if forwarded_htlc {
4004                 expect_pending_htlcs_forwardable!(nodes[1]);
4005                 check_added_monitors!(nodes[1], 1);
4006                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4007                 assert_eq!(fail_commit.len(), 1);
4008                 match fail_commit[0] {
4009                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4010                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4011                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4012                         },
4013                         _ => unreachable!(),
4014                 }
4015                 expect_payment_failed_with_update!(nodes[0], second_payment_hash, false, chan_2.0.contents.short_channel_id, false);
4016         } else {
4017                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4018         }
4019 }
4020
4021 #[test]
4022 fn test_holding_cell_htlc_add_timeouts() {
4023         do_test_holding_cell_htlc_add_timeouts(false);
4024         do_test_holding_cell_htlc_add_timeouts(true);
4025 }
4026
4027 #[test]
4028 fn test_no_txn_manager_serialize_deserialize() {
4029         let chanmon_cfgs = create_chanmon_cfgs(2);
4030         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4031         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4032         let logger: test_utils::TestLogger;
4033         let fee_estimator: test_utils::TestFeeEstimator;
4034         let persister: test_utils::TestPersister;
4035         let new_chain_monitor: test_utils::TestChainMonitor;
4036         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4037         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4038
4039         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4040
4041         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4042
4043         let nodes_0_serialized = nodes[0].node.encode();
4044         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4045         get_monitor!(nodes[0], OutPoint { txid: tx.txid(), index: 0 }.to_channel_id())
4046                 .write(&mut chan_0_monitor_serialized).unwrap();
4047
4048         logger = test_utils::TestLogger::new();
4049         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4050         persister = test_utils::TestPersister::new();
4051         let keys_manager = &chanmon_cfgs[0].keys_manager;
4052         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4053         nodes[0].chain_monitor = &new_chain_monitor;
4054         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4055         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4056                 &mut chan_0_monitor_read, keys_manager).unwrap();
4057         assert!(chan_0_monitor_read.is_empty());
4058
4059         let mut nodes_0_read = &nodes_0_serialized[..];
4060         let config = UserConfig::default();
4061         let (_, nodes_0_deserialized_tmp) = {
4062                 let mut channel_monitors = HashMap::new();
4063                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4064                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4065                         default_config: config,
4066                         keys_manager,
4067                         fee_estimator: &fee_estimator,
4068                         chain_monitor: nodes[0].chain_monitor,
4069                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4070                         logger: &logger,
4071                         channel_monitors,
4072                 }).unwrap()
4073         };
4074         nodes_0_deserialized = nodes_0_deserialized_tmp;
4075         assert!(nodes_0_read.is_empty());
4076
4077         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4078         nodes[0].node = &nodes_0_deserialized;
4079         assert_eq!(nodes[0].node.list_channels().len(), 1);
4080         check_added_monitors!(nodes[0], 1);
4081
4082         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4083         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4084         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4085         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4086
4087         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4088         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4089         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4090         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4091
4092         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4093         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4094         for node in nodes.iter() {
4095                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4096                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4097                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4098         }
4099
4100         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4101 }
4102
4103 #[test]
4104 fn test_manager_serialize_deserialize_events() {
4105         // This test makes sure the events field in ChannelManager survives de/serialization
4106         let chanmon_cfgs = create_chanmon_cfgs(2);
4107         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4108         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4109         let fee_estimator: test_utils::TestFeeEstimator;
4110         let persister: test_utils::TestPersister;
4111         let logger: test_utils::TestLogger;
4112         let new_chain_monitor: test_utils::TestChainMonitor;
4113         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4114         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4115
4116         // Start creating a channel, but stop right before broadcasting the funding transaction
4117         let channel_value = 100000;
4118         let push_msat = 10001;
4119         let a_flags = InitFeatures::known();
4120         let b_flags = InitFeatures::known();
4121         let node_a = nodes.remove(0);
4122         let node_b = nodes.remove(0);
4123         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4124         node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id()));
4125         node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id()));
4126
4127         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4128
4129         node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4130         check_added_monitors!(node_a, 0);
4131
4132         node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id()));
4133         {
4134                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4135                 assert_eq!(added_monitors.len(), 1);
4136                 assert_eq!(added_monitors[0].0, funding_output);
4137                 added_monitors.clear();
4138         }
4139
4140         let bs_funding_signed = get_event_msg!(node_b, MessageSendEvent::SendFundingSigned, node_a.node.get_our_node_id());
4141         node_a.node.handle_funding_signed(&node_b.node.get_our_node_id(), &bs_funding_signed);
4142         {
4143                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4144                 assert_eq!(added_monitors.len(), 1);
4145                 assert_eq!(added_monitors[0].0, funding_output);
4146                 added_monitors.clear();
4147         }
4148         // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4149
4150         nodes.push(node_a);
4151         nodes.push(node_b);
4152
4153         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4154         let nodes_0_serialized = nodes[0].node.encode();
4155         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4156         get_monitor!(nodes[0], bs_funding_signed.channel_id).write(&mut chan_0_monitor_serialized).unwrap();
4157
4158         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4159         logger = test_utils::TestLogger::new();
4160         persister = test_utils::TestPersister::new();
4161         let keys_manager = &chanmon_cfgs[0].keys_manager;
4162         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4163         nodes[0].chain_monitor = &new_chain_monitor;
4164         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4165         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4166                 &mut chan_0_monitor_read, keys_manager).unwrap();
4167         assert!(chan_0_monitor_read.is_empty());
4168
4169         let mut nodes_0_read = &nodes_0_serialized[..];
4170         let config = UserConfig::default();
4171         let (_, nodes_0_deserialized_tmp) = {
4172                 let mut channel_monitors = HashMap::new();
4173                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4174                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4175                         default_config: config,
4176                         keys_manager,
4177                         fee_estimator: &fee_estimator,
4178                         chain_monitor: nodes[0].chain_monitor,
4179                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4180                         logger: &logger,
4181                         channel_monitors,
4182                 }).unwrap()
4183         };
4184         nodes_0_deserialized = nodes_0_deserialized_tmp;
4185         assert!(nodes_0_read.is_empty());
4186
4187         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4188
4189         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4190         nodes[0].node = &nodes_0_deserialized;
4191
4192         // After deserializing, make sure the funding_transaction is still held by the channel manager
4193         let events_4 = nodes[0].node.get_and_clear_pending_events();
4194         assert_eq!(events_4.len(), 0);
4195         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4196         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4197
4198         // Make sure the channel is functioning as though the de/serialization never happened
4199         assert_eq!(nodes[0].node.list_channels().len(), 1);
4200         check_added_monitors!(nodes[0], 1);
4201
4202         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4203         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4204         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4205         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4206
4207         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4208         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4209         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4210         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4211
4212         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4213         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4214         for node in nodes.iter() {
4215                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4216                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4217                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4218         }
4219
4220         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4221 }
4222
4223 #[test]
4224 fn test_simple_manager_serialize_deserialize() {
4225         let chanmon_cfgs = create_chanmon_cfgs(2);
4226         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4227         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4228         let logger: test_utils::TestLogger;
4229         let fee_estimator: test_utils::TestFeeEstimator;
4230         let persister: test_utils::TestPersister;
4231         let new_chain_monitor: test_utils::TestChainMonitor;
4232         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4233         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4234         let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
4235
4236         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4237         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4238
4239         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4240
4241         let nodes_0_serialized = nodes[0].node.encode();
4242         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4243         get_monitor!(nodes[0], chan_id).write(&mut chan_0_monitor_serialized).unwrap();
4244
4245         logger = test_utils::TestLogger::new();
4246         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4247         persister = test_utils::TestPersister::new();
4248         let keys_manager = &chanmon_cfgs[0].keys_manager;
4249         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4250         nodes[0].chain_monitor = &new_chain_monitor;
4251         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4252         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4253                 &mut chan_0_monitor_read, keys_manager).unwrap();
4254         assert!(chan_0_monitor_read.is_empty());
4255
4256         let mut nodes_0_read = &nodes_0_serialized[..];
4257         let (_, nodes_0_deserialized_tmp) = {
4258                 let mut channel_monitors = HashMap::new();
4259                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4260                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4261                         default_config: UserConfig::default(),
4262                         keys_manager,
4263                         fee_estimator: &fee_estimator,
4264                         chain_monitor: nodes[0].chain_monitor,
4265                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4266                         logger: &logger,
4267                         channel_monitors,
4268                 }).unwrap()
4269         };
4270         nodes_0_deserialized = nodes_0_deserialized_tmp;
4271         assert!(nodes_0_read.is_empty());
4272
4273         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4274         nodes[0].node = &nodes_0_deserialized;
4275         check_added_monitors!(nodes[0], 1);
4276
4277         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4278
4279         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4280         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4281 }
4282
4283 #[test]
4284 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4285         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4286         let chanmon_cfgs = create_chanmon_cfgs(4);
4287         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4288         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4289         let logger: test_utils::TestLogger;
4290         let fee_estimator: test_utils::TestFeeEstimator;
4291         let persister: test_utils::TestPersister;
4292         let new_chain_monitor: test_utils::TestChainMonitor;
4293         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4294         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4295         let chan_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
4296         let chan_id_2 = create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known()).2;
4297         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4298
4299         let mut node_0_stale_monitors_serialized = Vec::new();
4300         for chan_id_iter in &[chan_id_1, chan_id_2, channel_id] {
4301                 let mut writer = test_utils::TestVecWriter(Vec::new());
4302                 get_monitor!(nodes[0], chan_id_iter).write(&mut writer).unwrap();
4303                 node_0_stale_monitors_serialized.push(writer.0);
4304         }
4305
4306         let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4307
4308         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4309         let nodes_0_serialized = nodes[0].node.encode();
4310
4311         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4312         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4313         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4314         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4315
4316         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4317         // nodes[3])
4318         let mut node_0_monitors_serialized = Vec::new();
4319         for chan_id_iter in &[chan_id_1, chan_id_2, channel_id] {
4320                 let mut writer = test_utils::TestVecWriter(Vec::new());
4321                 get_monitor!(nodes[0], chan_id_iter).write(&mut writer).unwrap();
4322                 node_0_monitors_serialized.push(writer.0);
4323         }
4324
4325         logger = test_utils::TestLogger::new();
4326         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4327         persister = test_utils::TestPersister::new();
4328         let keys_manager = &chanmon_cfgs[0].keys_manager;
4329         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4330         nodes[0].chain_monitor = &new_chain_monitor;
4331
4332
4333         let mut node_0_stale_monitors = Vec::new();
4334         for serialized in node_0_stale_monitors_serialized.iter() {
4335                 let mut read = &serialized[..];
4336                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4337                 assert!(read.is_empty());
4338                 node_0_stale_monitors.push(monitor);
4339         }
4340
4341         let mut node_0_monitors = Vec::new();
4342         for serialized in node_0_monitors_serialized.iter() {
4343                 let mut read = &serialized[..];
4344                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4345                 assert!(read.is_empty());
4346                 node_0_monitors.push(monitor);
4347         }
4348
4349         let mut nodes_0_read = &nodes_0_serialized[..];
4350         if let Err(msgs::DecodeError::InvalidValue) =
4351                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4352                 default_config: UserConfig::default(),
4353                 keys_manager,
4354                 fee_estimator: &fee_estimator,
4355                 chain_monitor: nodes[0].chain_monitor,
4356                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4357                 logger: &logger,
4358                 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4359         }) { } else {
4360                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4361         };
4362
4363         let mut nodes_0_read = &nodes_0_serialized[..];
4364         let (_, nodes_0_deserialized_tmp) =
4365                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4366                 default_config: UserConfig::default(),
4367                 keys_manager,
4368                 fee_estimator: &fee_estimator,
4369                 chain_monitor: nodes[0].chain_monitor,
4370                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4371                 logger: &logger,
4372                 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4373         }).unwrap();
4374         nodes_0_deserialized = nodes_0_deserialized_tmp;
4375         assert!(nodes_0_read.is_empty());
4376
4377         { // Channel close should result in a commitment tx
4378                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4379                 assert_eq!(txn.len(), 1);
4380                 check_spends!(txn[0], funding_tx);
4381                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4382         }
4383
4384         for monitor in node_0_monitors.drain(..) {
4385                 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4386                 check_added_monitors!(nodes[0], 1);
4387         }
4388         nodes[0].node = &nodes_0_deserialized;
4389         check_closed_event!(nodes[0], 1, ClosureReason::OutdatedChannelManager);
4390
4391         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4392         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4393         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4394         //... and we can even still claim the payment!
4395         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4396
4397         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4398         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4399         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4400         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4401         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4402         assert_eq!(msg_events.len(), 1);
4403         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4404                 match action {
4405                         &ErrorAction::SendErrorMessage { ref msg } => {
4406                                 assert_eq!(msg.channel_id, channel_id);
4407                         },
4408                         _ => panic!("Unexpected event!"),
4409                 }
4410         }
4411 }
4412
4413 macro_rules! check_spendable_outputs {
4414         ($node: expr, $keysinterface: expr) => {
4415                 {
4416                         let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4417                         let mut txn = Vec::new();
4418                         let mut all_outputs = Vec::new();
4419                         let secp_ctx = Secp256k1::new();
4420                         for event in events.drain(..) {
4421                                 match event {
4422                                         Event::SpendableOutputs { mut outputs } => {
4423                                                 for outp in outputs.drain(..) {
4424                                                         txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4425                                                         all_outputs.push(outp);
4426                                                 }
4427                                         },
4428                                         _ => panic!("Unexpected event"),
4429                                 };
4430                         }
4431                         if all_outputs.len() > 1 {
4432                                 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) {
4433                                         txn.push(tx);
4434                                 }
4435                         }
4436                         txn
4437                 }
4438         }
4439 }
4440
4441 #[test]
4442 fn test_claim_sizeable_push_msat() {
4443         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4444         let chanmon_cfgs = create_chanmon_cfgs(2);
4445         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4446         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4447         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4448
4449         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4450         nodes[1].node.force_close_channel(&chan.2).unwrap();
4451         check_closed_broadcast!(nodes[1], true);
4452         check_added_monitors!(nodes[1], 1);
4453         check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
4454         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4455         assert_eq!(node_txn.len(), 1);
4456         check_spends!(node_txn[0], chan.3);
4457         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
4458
4459         mine_transaction(&nodes[1], &node_txn[0]);
4460         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4461
4462         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4463         assert_eq!(spend_txn.len(), 1);
4464         assert_eq!(spend_txn[0].input.len(), 1);
4465         check_spends!(spend_txn[0], node_txn[0]);
4466         assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
4467 }
4468
4469 #[test]
4470 fn test_claim_on_remote_sizeable_push_msat() {
4471         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4472         // to_remote output is encumbered by a P2WPKH
4473         let chanmon_cfgs = create_chanmon_cfgs(2);
4474         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4475         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4476         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4477
4478         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4479         nodes[0].node.force_close_channel(&chan.2).unwrap();
4480         check_closed_broadcast!(nodes[0], true);
4481         check_added_monitors!(nodes[0], 1);
4482         check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
4483
4484         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4485         assert_eq!(node_txn.len(), 1);
4486         check_spends!(node_txn[0], chan.3);
4487         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
4488
4489         mine_transaction(&nodes[1], &node_txn[0]);
4490         check_closed_broadcast!(nodes[1], true);
4491         check_added_monitors!(nodes[1], 1);
4492         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4493         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4494
4495         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4496         assert_eq!(spend_txn.len(), 1);
4497         check_spends!(spend_txn[0], node_txn[0]);
4498 }
4499
4500 #[test]
4501 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4502         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4503         // to_remote output is encumbered by a P2WPKH
4504
4505         let chanmon_cfgs = create_chanmon_cfgs(2);
4506         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4507         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4508         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4509
4510         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4511         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4512         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4513         assert_eq!(revoked_local_txn[0].input.len(), 1);
4514         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4515
4516         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4517         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4518         check_closed_broadcast!(nodes[1], true);
4519         check_added_monitors!(nodes[1], 1);
4520         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4521
4522         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4523         mine_transaction(&nodes[1], &node_txn[0]);
4524         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4525
4526         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4527         assert_eq!(spend_txn.len(), 3);
4528         check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4529         check_spends!(spend_txn[1], node_txn[0]);
4530         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4531 }
4532
4533 #[test]
4534 fn test_static_spendable_outputs_preimage_tx() {
4535         let chanmon_cfgs = create_chanmon_cfgs(2);
4536         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4537         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4538         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4539
4540         // Create some initial channels
4541         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4542
4543         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4544
4545         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4546         assert_eq!(commitment_tx[0].input.len(), 1);
4547         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4548
4549         // Settle A's commitment tx on B's chain
4550         assert!(nodes[1].node.claim_funds(payment_preimage));
4551         check_added_monitors!(nodes[1], 1);
4552         mine_transaction(&nodes[1], &commitment_tx[0]);
4553         check_added_monitors!(nodes[1], 1);
4554         let events = nodes[1].node.get_and_clear_pending_msg_events();
4555         match events[0] {
4556                 MessageSendEvent::UpdateHTLCs { .. } => {},
4557                 _ => panic!("Unexpected event"),
4558         }
4559         match events[1] {
4560                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4561                 _ => panic!("Unexepected event"),
4562         }
4563
4564         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4565         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4566         assert_eq!(node_txn.len(), 3);
4567         check_spends!(node_txn[0], commitment_tx[0]);
4568         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4569         check_spends!(node_txn[1], chan_1.3);
4570         check_spends!(node_txn[2], node_txn[1]);
4571
4572         mine_transaction(&nodes[1], &node_txn[0]);
4573         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4574         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4575
4576         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4577         assert_eq!(spend_txn.len(), 1);
4578         check_spends!(spend_txn[0], node_txn[0]);
4579 }
4580
4581 #[test]
4582 fn test_static_spendable_outputs_timeout_tx() {
4583         let chanmon_cfgs = create_chanmon_cfgs(2);
4584         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4585         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4586         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4587
4588         // Create some initial channels
4589         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4590
4591         // Rebalance the network a bit by relaying one payment through all the channels ...
4592         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4593
4594         let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4595
4596         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4597         assert_eq!(commitment_tx[0].input.len(), 1);
4598         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4599
4600         // Settle A's commitment tx on B' chain
4601         mine_transaction(&nodes[1], &commitment_tx[0]);
4602         check_added_monitors!(nodes[1], 1);
4603         let events = nodes[1].node.get_and_clear_pending_msg_events();
4604         match events[0] {
4605                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4606                 _ => panic!("Unexpected event"),
4607         }
4608         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
4609
4610         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4611         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4612         assert_eq!(node_txn.len(), 2); // ChannelManager : 1 local commitent tx, ChannelMonitor: timeout tx
4613         check_spends!(node_txn[0], chan_1.3.clone());
4614         check_spends!(node_txn[1],  commitment_tx[0].clone());
4615         assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4616
4617         mine_transaction(&nodes[1], &node_txn[1]);
4618         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4619         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4620         expect_payment_failed!(nodes[1], our_payment_hash, true);
4621
4622         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4623         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
4624         check_spends!(spend_txn[0], commitment_tx[0]);
4625         check_spends!(spend_txn[1], node_txn[1]);
4626         check_spends!(spend_txn[2], node_txn[1], commitment_tx[0]); // All outputs
4627 }
4628
4629 #[test]
4630 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4631         let chanmon_cfgs = create_chanmon_cfgs(2);
4632         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4633         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4634         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4635
4636         // Create some initial channels
4637         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4638
4639         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4640         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4641         assert_eq!(revoked_local_txn[0].input.len(), 1);
4642         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4643
4644         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4645
4646         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4647         check_closed_broadcast!(nodes[1], true);
4648         check_added_monitors!(nodes[1], 1);
4649         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4650
4651         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4652         assert_eq!(node_txn.len(), 2);
4653         assert_eq!(node_txn[0].input.len(), 2);
4654         check_spends!(node_txn[0], revoked_local_txn[0]);
4655
4656         mine_transaction(&nodes[1], &node_txn[0]);
4657         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4658
4659         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4660         assert_eq!(spend_txn.len(), 1);
4661         check_spends!(spend_txn[0], node_txn[0]);
4662 }
4663
4664 #[test]
4665 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4666         let mut chanmon_cfgs = create_chanmon_cfgs(2);
4667         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
4668         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4669         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4670         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4671
4672         // Create some initial channels
4673         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4674
4675         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4676         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4677         assert_eq!(revoked_local_txn[0].input.len(), 1);
4678         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4679
4680         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4681
4682         // A will generate HTLC-Timeout from revoked commitment tx
4683         mine_transaction(&nodes[0], &revoked_local_txn[0]);
4684         check_closed_broadcast!(nodes[0], true);
4685         check_added_monitors!(nodes[0], 1);
4686         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
4687         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
4688
4689         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4690         assert_eq!(revoked_htlc_txn.len(), 2);
4691         check_spends!(revoked_htlc_txn[0], chan_1.3);
4692         assert_eq!(revoked_htlc_txn[1].input.len(), 1);
4693         assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4694         check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
4695         assert_ne!(revoked_htlc_txn[1].lock_time, 0); // HTLC-Timeout
4696
4697         // B will generate justice tx from A's revoked commitment/HTLC tx
4698         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4699         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
4700         check_closed_broadcast!(nodes[1], true);
4701         check_added_monitors!(nodes[1], 1);
4702         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4703
4704         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4705         assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
4706         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4707         // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
4708         // transactions next...
4709         assert_eq!(node_txn[0].input.len(), 3);
4710         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
4711
4712         assert_eq!(node_txn[1].input.len(), 2);
4713         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
4714         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
4715                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
4716         } else {
4717                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
4718                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
4719         }
4720
4721         assert_eq!(node_txn[2].input.len(), 1);
4722         check_spends!(node_txn[2], chan_1.3);
4723
4724         mine_transaction(&nodes[1], &node_txn[1]);
4725         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4726
4727         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4728         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4729         assert_eq!(spend_txn.len(), 1);
4730         assert_eq!(spend_txn[0].input.len(), 1);
4731         check_spends!(spend_txn[0], node_txn[1]);
4732 }
4733
4734 #[test]
4735 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4736         let mut chanmon_cfgs = create_chanmon_cfgs(2);
4737         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
4738         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4739         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4740         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4741
4742         // Create some initial channels
4743         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4744
4745         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4746         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4747         assert_eq!(revoked_local_txn[0].input.len(), 1);
4748         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4749
4750         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
4751         assert_eq!(revoked_local_txn[0].output.len(), 2);
4752
4753         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4754
4755         // B will generate HTLC-Success from revoked commitment tx
4756         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4757         check_closed_broadcast!(nodes[1], true);
4758         check_added_monitors!(nodes[1], 1);
4759         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4760         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4761
4762         assert_eq!(revoked_htlc_txn.len(), 2);
4763         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4764         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4765         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4766
4767         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
4768         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
4769         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
4770
4771         // A will generate justice tx from B's revoked commitment/HTLC tx
4772         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4773         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
4774         check_closed_broadcast!(nodes[0], true);
4775         check_added_monitors!(nodes[0], 1);
4776         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
4777
4778         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4779         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4780
4781         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4782         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
4783         // transactions next...
4784         assert_eq!(node_txn[0].input.len(), 2);
4785         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4786         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4787                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4788         } else {
4789                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
4790                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4791         }
4792
4793         assert_eq!(node_txn[1].input.len(), 1);
4794         check_spends!(node_txn[1], revoked_htlc_txn[0]);
4795
4796         check_spends!(node_txn[2], chan_1.3);
4797
4798         mine_transaction(&nodes[0], &node_txn[1]);
4799         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
4800
4801         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
4802         // didn't try to generate any new transactions.
4803
4804         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4805         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
4806         assert_eq!(spend_txn.len(), 3);
4807         assert_eq!(spend_txn[0].input.len(), 1);
4808         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
4809         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4810         check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
4811         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
4812 }
4813
4814 #[test]
4815 fn test_onchain_to_onchain_claim() {
4816         // Test that in case of channel closure, we detect the state of output and claim HTLC
4817         // on downstream peer's remote commitment tx.
4818         // First, have C claim an HTLC against its own latest commitment transaction.
4819         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4820         // channel.
4821         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4822         // gets broadcast.
4823
4824         let chanmon_cfgs = create_chanmon_cfgs(3);
4825         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4826         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4827         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4828
4829         // Create some initial channels
4830         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4831         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4832
4833         // Ensure all nodes are at the same height
4834         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
4835         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
4836         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
4837         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
4838
4839         // Rebalance the network a bit by relaying one payment through all the channels ...
4840         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
4841         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
4842
4843         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
4844         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
4845         check_spends!(commitment_tx[0], chan_2.3);
4846         nodes[2].node.claim_funds(payment_preimage);
4847         check_added_monitors!(nodes[2], 1);
4848         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4849         assert!(updates.update_add_htlcs.is_empty());
4850         assert!(updates.update_fail_htlcs.is_empty());
4851         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4852         assert!(updates.update_fail_malformed_htlcs.is_empty());
4853
4854         mine_transaction(&nodes[2], &commitment_tx[0]);
4855         check_closed_broadcast!(nodes[2], true);
4856         check_added_monitors!(nodes[2], 1);
4857         check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
4858
4859         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
4860         assert_eq!(c_txn.len(), 3);
4861         assert_eq!(c_txn[0], c_txn[2]);
4862         assert_eq!(commitment_tx[0], c_txn[1]);
4863         check_spends!(c_txn[1], chan_2.3);
4864         check_spends!(c_txn[2], c_txn[1]);
4865         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
4866         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4867         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4868         assert_eq!(c_txn[0].lock_time, 0); // Success tx
4869
4870         // 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
4871         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4872         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
4873         check_added_monitors!(nodes[1], 1);
4874         let events = nodes[1].node.get_and_clear_pending_events();
4875         assert_eq!(events.len(), 2);
4876         match events[0] {
4877                 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
4878                 _ => panic!("Unexpected event"),
4879         }
4880         match events[1] {
4881                 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
4882                         assert_eq!(fee_earned_msat, Some(1000));
4883                         assert_eq!(claim_from_onchain_tx, true);
4884                 },
4885                 _ => panic!("Unexpected event"),
4886         }
4887         {
4888                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4889                 // ChannelMonitor: claim tx
4890                 assert_eq!(b_txn.len(), 1);
4891                 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
4892                 b_txn.clear();
4893         }
4894         check_added_monitors!(nodes[1], 1);
4895         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4896         assert_eq!(msg_events.len(), 3);
4897         match msg_events[0] {
4898                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4899                 _ => panic!("Unexpected event"),
4900         }
4901         match msg_events[1] {
4902                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
4903                 _ => panic!("Unexpected event"),
4904         }
4905         match msg_events[2] {
4906                 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, .. } } => {
4907                         assert!(update_add_htlcs.is_empty());
4908                         assert!(update_fail_htlcs.is_empty());
4909                         assert_eq!(update_fulfill_htlcs.len(), 1);
4910                         assert!(update_fail_malformed_htlcs.is_empty());
4911                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
4912                 },
4913                 _ => panic!("Unexpected event"),
4914         };
4915         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
4916         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4917         mine_transaction(&nodes[1], &commitment_tx[0]);
4918         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4919         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4920         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
4921         assert_eq!(b_txn.len(), 3);
4922         check_spends!(b_txn[1], chan_1.3);
4923         check_spends!(b_txn[2], b_txn[1]);
4924         check_spends!(b_txn[0], commitment_tx[0]);
4925         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4926         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4927         assert_eq!(b_txn[0].lock_time, 0); // Success tx
4928
4929         check_closed_broadcast!(nodes[1], true);
4930         check_added_monitors!(nodes[1], 1);
4931 }
4932
4933 #[test]
4934 fn test_duplicate_payment_hash_one_failure_one_success() {
4935         // Topology : A --> B --> C --> D
4936         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
4937         // Note that because C will refuse to generate two payment secrets for the same payment hash,
4938         // we forward one of the payments onwards to D.
4939         let chanmon_cfgs = create_chanmon_cfgs(4);
4940         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4941         // When this test was written, the default base fee floated based on the HTLC count.
4942         // It is now fixed, so we simply set the fee to the expected value here.
4943         let mut config = test_default_channel_config();
4944         config.channel_options.forwarding_fee_base_msat = 196;
4945         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs,
4946                 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
4947         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4948
4949         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4950         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4951         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
4952
4953         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
4954         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
4955         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
4956         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
4957         connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
4958
4959         let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
4960
4961         let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
4962         // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
4963         // script push size limit so that the below script length checks match
4964         // ACCEPTED_HTLC_SCRIPT_WEIGHT.
4965         let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[3], vec![], 900000, TEST_FINAL_CLTV - 40);
4966         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
4967
4968         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
4969         assert_eq!(commitment_txn[0].input.len(), 1);
4970         check_spends!(commitment_txn[0], chan_2.3);
4971
4972         mine_transaction(&nodes[1], &commitment_txn[0]);
4973         check_closed_broadcast!(nodes[1], true);
4974         check_added_monitors!(nodes[1], 1);
4975         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4976         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
4977
4978         let htlc_timeout_tx;
4979         { // Extract one of the two HTLC-Timeout transaction
4980                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4981                 // ChannelMonitor: timeout tx * 3, ChannelManager: local commitment tx
4982                 assert_eq!(node_txn.len(), 4);
4983                 check_spends!(node_txn[0], chan_2.3);
4984
4985                 check_spends!(node_txn[1], commitment_txn[0]);
4986                 assert_eq!(node_txn[1].input.len(), 1);
4987                 check_spends!(node_txn[2], commitment_txn[0]);
4988                 assert_eq!(node_txn[2].input.len(), 1);
4989                 assert_eq!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
4990                 check_spends!(node_txn[3], commitment_txn[0]);
4991                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[3].input[0].previous_output);
4992
4993                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4994                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4995                 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4996                 htlc_timeout_tx = node_txn[1].clone();
4997         }
4998
4999         nodes[2].node.claim_funds(our_payment_preimage);
5000         mine_transaction(&nodes[2], &commitment_txn[0]);
5001         check_added_monitors!(nodes[2], 2);
5002         check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
5003         let events = nodes[2].node.get_and_clear_pending_msg_events();
5004         match events[0] {
5005                 MessageSendEvent::UpdateHTLCs { .. } => {},
5006                 _ => panic!("Unexpected event"),
5007         }
5008         match events[1] {
5009                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5010                 _ => panic!("Unexepected event"),
5011         }
5012         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5013         assert_eq!(htlc_success_txn.len(), 5); // ChannelMonitor: HTLC-Success txn (*2 due to 2-HTLC outputs), ChannelManager: local commitment tx + HTLC-Success txn (*2 due to 2-HTLC outputs)
5014         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5015         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5016         assert_eq!(htlc_success_txn[0].input.len(), 1);
5017         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5018         assert_eq!(htlc_success_txn[1].input.len(), 1);
5019         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5020         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5021         assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5022         assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5023         assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5024         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5025
5026         mine_transaction(&nodes[1], &htlc_timeout_tx);
5027         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5028         expect_pending_htlcs_forwardable!(nodes[1]);
5029         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5030         assert!(htlc_updates.update_add_htlcs.is_empty());
5031         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5032         let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5033         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5034         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5035         check_added_monitors!(nodes[1], 1);
5036
5037         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5038         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5039         {
5040                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5041         }
5042         expect_payment_failed_with_update!(nodes[0], duplicate_payment_hash, false, chan_2.0.contents.short_channel_id, true);
5043
5044         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5045         // Note that the fee paid is effectively double as the HTLC value (including the nodes[1] fee
5046         // and nodes[2] fee) is rounded down and then claimed in full.
5047         mine_transaction(&nodes[1], &htlc_success_txn[0]);
5048         expect_payment_forwarded!(nodes[1], Some(196*2), true);
5049         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5050         assert!(updates.update_add_htlcs.is_empty());
5051         assert!(updates.update_fail_htlcs.is_empty());
5052         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5053         assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5054         assert!(updates.update_fail_malformed_htlcs.is_empty());
5055         check_added_monitors!(nodes[1], 1);
5056
5057         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5058         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5059
5060         let events = nodes[0].node.get_and_clear_pending_events();
5061         match events[0] {
5062                 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
5063                         assert_eq!(*payment_preimage, our_payment_preimage);
5064                         assert_eq!(*payment_hash, duplicate_payment_hash);
5065                 }
5066                 _ => panic!("Unexpected event"),
5067         }
5068 }
5069
5070 #[test]
5071 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5072         let chanmon_cfgs = create_chanmon_cfgs(2);
5073         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5074         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5075         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5076
5077         // Create some initial channels
5078         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5079
5080         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5081         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5082         assert_eq!(local_txn.len(), 1);
5083         assert_eq!(local_txn[0].input.len(), 1);
5084         check_spends!(local_txn[0], chan_1.3);
5085
5086         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5087         nodes[1].node.claim_funds(payment_preimage);
5088         check_added_monitors!(nodes[1], 1);
5089         mine_transaction(&nodes[1], &local_txn[0]);
5090         check_added_monitors!(nodes[1], 1);
5091         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
5092         let events = nodes[1].node.get_and_clear_pending_msg_events();
5093         match events[0] {
5094                 MessageSendEvent::UpdateHTLCs { .. } => {},
5095                 _ => panic!("Unexpected event"),
5096         }
5097         match events[1] {
5098                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5099                 _ => panic!("Unexepected event"),
5100         }
5101         let node_tx = {
5102                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5103                 assert_eq!(node_txn.len(), 3);
5104                 assert_eq!(node_txn[0], node_txn[2]);
5105                 assert_eq!(node_txn[1], local_txn[0]);
5106                 assert_eq!(node_txn[0].input.len(), 1);
5107                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5108                 check_spends!(node_txn[0], local_txn[0]);
5109                 node_txn[0].clone()
5110         };
5111
5112         mine_transaction(&nodes[1], &node_tx);
5113         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
5114
5115         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5116         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5117         assert_eq!(spend_txn.len(), 1);
5118         assert_eq!(spend_txn[0].input.len(), 1);
5119         check_spends!(spend_txn[0], node_tx);
5120         assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5121 }
5122
5123 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5124         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5125         // unrevoked commitment transaction.
5126         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5127         // a remote RAA before they could be failed backwards (and combinations thereof).
5128         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5129         // use the same payment hashes.
5130         // Thus, we use a six-node network:
5131         //
5132         // A \         / E
5133         //    - C - D -
5134         // B /         \ F
5135         // And test where C fails back to A/B when D announces its latest commitment transaction
5136         let chanmon_cfgs = create_chanmon_cfgs(6);
5137         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5138         // When this test was written, the default base fee floated based on the HTLC count.
5139         // It is now fixed, so we simply set the fee to the expected value here.
5140         let mut config = test_default_channel_config();
5141         config.channel_options.forwarding_fee_base_msat = 196;
5142         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs,
5143                 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5144         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5145
5146         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5147         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5148         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5149         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5150         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5151
5152         // Rebalance and check output sanity...
5153         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5154         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5155         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5156
5157         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5158         // 0th HTLC:
5159         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
5160         // 1st HTLC:
5161         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
5162         let (route, _, _, _) = get_route_and_payment_hash!(nodes[1], nodes[5], ds_dust_limit*1000);
5163         // 2nd HTLC:
5164         send_along_route_with_secret(&nodes[1], route.clone(), &[&[&nodes[2], &nodes[3], &nodes[5]]], ds_dust_limit*1000, payment_hash_1, nodes[5].node.create_inbound_payment_for_hash(payment_hash_1, None, 7200, 0).unwrap()); // not added < dust limit + HTLC tx fee
5165         // 3rd HTLC:
5166         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], ds_dust_limit*1000, payment_hash_2, nodes[5].node.create_inbound_payment_for_hash(payment_hash_2, None, 7200, 0).unwrap()); // not added < dust limit + HTLC tx fee
5167         // 4th HTLC:
5168         let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5169         // 5th HTLC:
5170         let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5171         let (route, _, _, _) = get_route_and_payment_hash!(nodes[1], nodes[5], 1000000);
5172         // 6th HTLC:
5173         send_along_route_with_secret(&nodes[1], route.clone(), &[&[&nodes[2], &nodes[3], &nodes[5]]], 1000000, payment_hash_3, nodes[5].node.create_inbound_payment_for_hash(payment_hash_3, None, 7200, 0).unwrap());
5174         // 7th HTLC:
5175         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], 1000000, payment_hash_4, nodes[5].node.create_inbound_payment_for_hash(payment_hash_4, None, 7200, 0).unwrap());
5176
5177         // 8th HTLC:
5178         let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5179         // 9th HTLC:
5180         let (route, _, _, _) = get_route_and_payment_hash!(nodes[1], nodes[5], ds_dust_limit*1000);
5181         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], ds_dust_limit*1000, payment_hash_5, nodes[5].node.create_inbound_payment_for_hash(payment_hash_5, None, 7200, 0).unwrap()); // not added < dust limit + HTLC tx fee
5182
5183         // 10th HTLC:
5184         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
5185         // 11th HTLC:
5186         let (route, _, _, _) = get_route_and_payment_hash!(nodes[1], nodes[5], 1000000);
5187         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], 1000000, payment_hash_6, nodes[5].node.create_inbound_payment_for_hash(payment_hash_6, None, 7200, 0).unwrap());
5188
5189         // Double-check that six of the new HTLC were added
5190         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5191         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5192         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5193         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5194
5195         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5196         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5197         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5198         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5199         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5200         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5201         check_added_monitors!(nodes[4], 0);
5202         expect_pending_htlcs_forwardable!(nodes[4]);
5203         check_added_monitors!(nodes[4], 1);
5204
5205         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5206         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5207         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5208         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5209         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5210         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5211
5212         // Fail 3rd below-dust and 7th above-dust HTLCs
5213         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5214         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5215         check_added_monitors!(nodes[5], 0);
5216         expect_pending_htlcs_forwardable!(nodes[5]);
5217         check_added_monitors!(nodes[5], 1);
5218
5219         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5220         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5221         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5222         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5223
5224         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5225
5226         expect_pending_htlcs_forwardable!(nodes[3]);
5227         check_added_monitors!(nodes[3], 1);
5228         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5229         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5230         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5231         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5232         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5233         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5234         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5235         if deliver_last_raa {
5236                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5237         } else {
5238                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5239         }
5240
5241         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5242         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5243         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5244         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5245         //
5246         // We now broadcast the latest commitment transaction, which *should* result in failures for
5247         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5248         // the non-broadcast above-dust HTLCs.
5249         //
5250         // Alternatively, we may broadcast the previous commitment transaction, which should only
5251         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5252         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5253
5254         if announce_latest {
5255                 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5256         } else {
5257                 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5258         }
5259         let events = nodes[2].node.get_and_clear_pending_events();
5260         let close_event = if deliver_last_raa {
5261                 assert_eq!(events.len(), 2);
5262                 events[1].clone()
5263         } else {
5264                 assert_eq!(events.len(), 1);
5265                 events[0].clone()
5266         };
5267         match close_event {
5268                 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
5269                 _ => panic!("Unexpected event"),
5270         }
5271
5272         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5273         check_closed_broadcast!(nodes[2], true);
5274         if deliver_last_raa {
5275                 expect_pending_htlcs_forwardable_from_events!(nodes[2], events[0..1], true);
5276         } else {
5277                 expect_pending_htlcs_forwardable!(nodes[2]);
5278         }
5279         check_added_monitors!(nodes[2], 3);
5280
5281         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5282         assert_eq!(cs_msgs.len(), 2);
5283         let mut a_done = false;
5284         for msg in cs_msgs {
5285                 match msg {
5286                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5287                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5288                                 // should be failed-backwards here.
5289                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5290                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5291                                         for htlc in &updates.update_fail_htlcs {
5292                                                 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 });
5293                                         }
5294                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5295                                         assert!(!a_done);
5296                                         a_done = true;
5297                                         &nodes[0]
5298                                 } else {
5299                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5300                                         for htlc in &updates.update_fail_htlcs {
5301                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5302                                         }
5303                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5304                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5305                                         &nodes[1]
5306                                 };
5307                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5308                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5309                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5310                                 if announce_latest {
5311                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5312                                         if *node_id == nodes[0].node.get_our_node_id() {
5313                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5314                                         }
5315                                 }
5316                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5317                         },
5318                         _ => panic!("Unexpected event"),
5319                 }
5320         }
5321
5322         let as_events = nodes[0].node.get_and_clear_pending_events();
5323         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5324         let mut as_failds = HashSet::new();
5325         let mut as_updates = 0;
5326         for event in as_events.iter() {
5327                 if let &Event::PaymentPathFailed { ref payment_hash, ref rejected_by_dest, ref network_update, .. } = event {
5328                         assert!(as_failds.insert(*payment_hash));
5329                         if *payment_hash != payment_hash_2 {
5330                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5331                         } else {
5332                                 assert!(!rejected_by_dest);
5333                         }
5334                         if network_update.is_some() {
5335                                 as_updates += 1;
5336                         }
5337                 } else { panic!("Unexpected event"); }
5338         }
5339         assert!(as_failds.contains(&payment_hash_1));
5340         assert!(as_failds.contains(&payment_hash_2));
5341         if announce_latest {
5342                 assert!(as_failds.contains(&payment_hash_3));
5343                 assert!(as_failds.contains(&payment_hash_5));
5344         }
5345         assert!(as_failds.contains(&payment_hash_6));
5346
5347         let bs_events = nodes[1].node.get_and_clear_pending_events();
5348         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5349         let mut bs_failds = HashSet::new();
5350         let mut bs_updates = 0;
5351         for event in bs_events.iter() {
5352                 if let &Event::PaymentPathFailed { ref payment_hash, ref rejected_by_dest, ref network_update, .. } = event {
5353                         assert!(bs_failds.insert(*payment_hash));
5354                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5355                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5356                         } else {
5357                                 assert!(!rejected_by_dest);
5358                         }
5359                         if network_update.is_some() {
5360                                 bs_updates += 1;
5361                         }
5362                 } else { panic!("Unexpected event"); }
5363         }
5364         assert!(bs_failds.contains(&payment_hash_1));
5365         assert!(bs_failds.contains(&payment_hash_2));
5366         if announce_latest {
5367                 assert!(bs_failds.contains(&payment_hash_4));
5368         }
5369         assert!(bs_failds.contains(&payment_hash_5));
5370
5371         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5372         // get a NetworkUpdate. A should have gotten 4 HTLCs which were failed-back due to
5373         // unknown-preimage-etc, B should have gotten 2. Thus, in the
5374         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2 NetworkUpdates.
5375         assert_eq!(as_updates, if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5376         assert_eq!(bs_updates, if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5377 }
5378
5379 #[test]
5380 fn test_fail_backwards_latest_remote_announce_a() {
5381         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5382 }
5383
5384 #[test]
5385 fn test_fail_backwards_latest_remote_announce_b() {
5386         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5387 }
5388
5389 #[test]
5390 fn test_fail_backwards_previous_remote_announce() {
5391         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5392         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5393         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5394 }
5395
5396 #[test]
5397 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5398         let chanmon_cfgs = create_chanmon_cfgs(2);
5399         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5400         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5401         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5402
5403         // Create some initial channels
5404         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5405
5406         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5407         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5408         assert_eq!(local_txn[0].input.len(), 1);
5409         check_spends!(local_txn[0], chan_1.3);
5410
5411         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5412         mine_transaction(&nodes[0], &local_txn[0]);
5413         check_closed_broadcast!(nodes[0], true);
5414         check_added_monitors!(nodes[0], 1);
5415         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
5416         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5417
5418         let htlc_timeout = {
5419                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5420                 assert_eq!(node_txn.len(), 2);
5421                 check_spends!(node_txn[0], chan_1.3);
5422                 assert_eq!(node_txn[1].input.len(), 1);
5423                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5424                 check_spends!(node_txn[1], local_txn[0]);
5425                 node_txn[1].clone()
5426         };
5427
5428         mine_transaction(&nodes[0], &htlc_timeout);
5429         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5430         expect_payment_failed!(nodes[0], our_payment_hash, true);
5431
5432         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5433         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5434         assert_eq!(spend_txn.len(), 3);
5435         check_spends!(spend_txn[0], local_txn[0]);
5436         assert_eq!(spend_txn[1].input.len(), 1);
5437         check_spends!(spend_txn[1], htlc_timeout);
5438         assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5439         assert_eq!(spend_txn[2].input.len(), 2);
5440         check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5441         assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5442                 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5443 }
5444
5445 #[test]
5446 fn test_key_derivation_params() {
5447         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5448         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5449         // let us re-derive the channel key set to then derive a delayed_payment_key.
5450
5451         let chanmon_cfgs = create_chanmon_cfgs(3);
5452
5453         // We manually create the node configuration to backup the seed.
5454         let seed = [42; 32];
5455         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5456         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);
5457         let node = NodeCfg { chain_source: &chanmon_cfgs[0].chain_source, logger: &chanmon_cfgs[0].logger, tx_broadcaster: &chanmon_cfgs[0].tx_broadcaster, fee_estimator: &chanmon_cfgs[0].fee_estimator, chain_monitor, keys_manager: &keys_manager, node_seed: seed, features: InitFeatures::known() };
5458         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5459         node_cfgs.remove(0);
5460         node_cfgs.insert(0, node);
5461
5462         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5463         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5464
5465         // Create some initial channels
5466         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5467         // for node 0
5468         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5469         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5470         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5471
5472         // Ensure all nodes are at the same height
5473         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5474         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5475         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5476         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5477
5478         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5479         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5480         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5481         assert_eq!(local_txn_1[0].input.len(), 1);
5482         check_spends!(local_txn_1[0], chan_1.3);
5483
5484         // We check funding pubkey are unique
5485         let (from_0_funding_key_0, from_0_funding_key_1) = (PublicKey::from_slice(&local_txn_0[0].input[0].witness[3][2..35]), PublicKey::from_slice(&local_txn_0[0].input[0].witness[3][36..69]));
5486         let (from_1_funding_key_0, from_1_funding_key_1) = (PublicKey::from_slice(&local_txn_1[0].input[0].witness[3][2..35]), PublicKey::from_slice(&local_txn_1[0].input[0].witness[3][36..69]));
5487         if from_0_funding_key_0 == from_1_funding_key_0
5488             || from_0_funding_key_0 == from_1_funding_key_1
5489             || from_0_funding_key_1 == from_1_funding_key_0
5490             || from_0_funding_key_1 == from_1_funding_key_1 {
5491                 panic!("Funding pubkeys aren't unique");
5492         }
5493
5494         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5495         mine_transaction(&nodes[0], &local_txn_1[0]);
5496         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5497         check_closed_broadcast!(nodes[0], true);
5498         check_added_monitors!(nodes[0], 1);
5499         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
5500
5501         let htlc_timeout = {
5502                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5503                 assert_eq!(node_txn[1].input.len(), 1);
5504                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5505                 check_spends!(node_txn[1], local_txn_1[0]);
5506                 node_txn[1].clone()
5507         };
5508
5509         mine_transaction(&nodes[0], &htlc_timeout);
5510         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5511         expect_payment_failed!(nodes[0], our_payment_hash, true);
5512
5513         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5514         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5515         let spend_txn = check_spendable_outputs!(nodes[0], new_keys_manager);
5516         assert_eq!(spend_txn.len(), 3);
5517         check_spends!(spend_txn[0], local_txn_1[0]);
5518         assert_eq!(spend_txn[1].input.len(), 1);
5519         check_spends!(spend_txn[1], htlc_timeout);
5520         assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5521         assert_eq!(spend_txn[2].input.len(), 2);
5522         check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5523         assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5524                 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5525 }
5526
5527 #[test]
5528 fn test_static_output_closing_tx() {
5529         let chanmon_cfgs = create_chanmon_cfgs(2);
5530         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5531         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5532         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5533
5534         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5535
5536         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5537         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5538
5539         mine_transaction(&nodes[0], &closing_tx);
5540         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
5541         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5542
5543         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5544         assert_eq!(spend_txn.len(), 1);
5545         check_spends!(spend_txn[0], closing_tx);
5546
5547         mine_transaction(&nodes[1], &closing_tx);
5548         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
5549         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5550
5551         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5552         assert_eq!(spend_txn.len(), 1);
5553         check_spends!(spend_txn[0], closing_tx);
5554 }
5555
5556 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5557         let chanmon_cfgs = create_chanmon_cfgs(2);
5558         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5559         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5560         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5561         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5562
5563         let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5564
5565         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5566         // present in B's local commitment transaction, but none of A's commitment transactions.
5567         assert!(nodes[1].node.claim_funds(our_payment_preimage));
5568         check_added_monitors!(nodes[1], 1);
5569
5570         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5571         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5572         let events = nodes[0].node.get_and_clear_pending_events();
5573         assert_eq!(events.len(), 1);
5574         match events[0] {
5575                 Event::PaymentSent { payment_preimage, payment_hash, .. } => {
5576                         assert_eq!(payment_preimage, our_payment_preimage);
5577                         assert_eq!(payment_hash, our_payment_hash);
5578                 },
5579                 _ => panic!("Unexpected event"),
5580         }
5581
5582         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5583         check_added_monitors!(nodes[0], 1);
5584         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5585         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5586         check_added_monitors!(nodes[1], 1);
5587
5588         let starting_block = nodes[1].best_block_info();
5589         let mut block = Block {
5590                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5591                 txdata: vec![],
5592         };
5593         for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5594                 connect_block(&nodes[1], &block);
5595                 block.header.prev_blockhash = block.block_hash();
5596         }
5597         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5598         check_closed_broadcast!(nodes[1], true);
5599         check_added_monitors!(nodes[1], 1);
5600         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
5601 }
5602
5603 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5604         let chanmon_cfgs = create_chanmon_cfgs(2);
5605         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5606         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5607         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5608         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5609
5610         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], if use_dust { 50000 } else { 3000000 });
5611         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5612         check_added_monitors!(nodes[0], 1);
5613
5614         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5615
5616         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5617         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5618         // to "time out" the HTLC.
5619
5620         let starting_block = nodes[1].best_block_info();
5621         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5622
5623         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5624                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5625                 header.prev_blockhash = header.block_hash();
5626         }
5627         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5628         check_closed_broadcast!(nodes[0], true);
5629         check_added_monitors!(nodes[0], 1);
5630         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
5631 }
5632
5633 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5634         let chanmon_cfgs = create_chanmon_cfgs(3);
5635         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5636         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5637         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5638         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5639
5640         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5641         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5642         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5643         // actually revoked.
5644         let htlc_value = if use_dust { 50000 } else { 3000000 };
5645         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5646         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
5647         expect_pending_htlcs_forwardable!(nodes[1]);
5648         check_added_monitors!(nodes[1], 1);
5649
5650         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5651         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5652         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5653         check_added_monitors!(nodes[0], 1);
5654         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5655         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5656         check_added_monitors!(nodes[1], 1);
5657         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5658         check_added_monitors!(nodes[1], 1);
5659         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5660
5661         if check_revoke_no_close {
5662                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5663                 check_added_monitors!(nodes[0], 1);
5664         }
5665
5666         let starting_block = nodes[1].best_block_info();
5667         let mut block = Block {
5668                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5669                 txdata: vec![],
5670         };
5671         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
5672                 connect_block(&nodes[0], &block);
5673                 block.header.prev_blockhash = block.block_hash();
5674         }
5675         if !check_revoke_no_close {
5676                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5677                 check_closed_broadcast!(nodes[0], true);
5678                 check_added_monitors!(nodes[0], 1);
5679                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
5680         } else {
5681                 expect_payment_failed!(nodes[0], our_payment_hash, true);
5682         }
5683 }
5684
5685 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5686 // There are only a few cases to test here:
5687 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5688 //    broadcastable commitment transactions result in channel closure,
5689 //  * its included in an unrevoked-but-previous remote commitment transaction,
5690 //  * its included in the latest remote or local commitment transactions.
5691 // We test each of the three possible commitment transactions individually and use both dust and
5692 // non-dust HTLCs.
5693 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5694 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5695 // tested for at least one of the cases in other tests.
5696 #[test]
5697 fn htlc_claim_single_commitment_only_a() {
5698         do_htlc_claim_local_commitment_only(true);
5699         do_htlc_claim_local_commitment_only(false);
5700
5701         do_htlc_claim_current_remote_commitment_only(true);
5702         do_htlc_claim_current_remote_commitment_only(false);
5703 }
5704
5705 #[test]
5706 fn htlc_claim_single_commitment_only_b() {
5707         do_htlc_claim_previous_remote_commitment_only(true, false);
5708         do_htlc_claim_previous_remote_commitment_only(false, false);
5709         do_htlc_claim_previous_remote_commitment_only(true, true);
5710         do_htlc_claim_previous_remote_commitment_only(false, true);
5711 }
5712
5713 #[test]
5714 #[should_panic]
5715 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5716         let chanmon_cfgs = create_chanmon_cfgs(2);
5717         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5718         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5719         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5720         //Force duplicate channel ids
5721         for node in nodes.iter() {
5722                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5723         }
5724
5725         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5726         let channel_value_satoshis=10000;
5727         let push_msat=10001;
5728         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5729         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5730         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
5731
5732         //Create a second channel with a channel_id collision
5733         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5734 }
5735
5736 #[test]
5737 fn bolt2_open_channel_sending_node_checks_part2() {
5738         let chanmon_cfgs = create_chanmon_cfgs(2);
5739         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5740         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5741         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5742
5743         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5744         let channel_value_satoshis=2^24;
5745         let push_msat=10001;
5746         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5747
5748         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5749         let channel_value_satoshis=10000;
5750         // Test when push_msat is equal to 1000 * funding_satoshis.
5751         let push_msat=1000*channel_value_satoshis+1;
5752         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5753
5754         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5755         let channel_value_satoshis=10000;
5756         let push_msat=10001;
5757         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
5758         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5759         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5760
5761         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5762         // 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
5763         assert!(node0_to_1_send_open_channel.channel_flags<=1);
5764
5765         // 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.
5766         assert!(BREAKDOWN_TIMEOUT>0);
5767         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5768
5769         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5770         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
5771         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5772
5773         // 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.
5774         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5775         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5776         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5777         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
5778         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5779 }
5780
5781 #[test]
5782 fn bolt2_open_channel_sane_dust_limit() {
5783         let chanmon_cfgs = create_chanmon_cfgs(2);
5784         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5785         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5786         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5787
5788         let channel_value_satoshis=1000000;
5789         let push_msat=10001;
5790         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5791         let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5792         node0_to_1_send_open_channel.dust_limit_satoshis = 547;
5793         node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
5794
5795         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
5796         let events = nodes[1].node.get_and_clear_pending_msg_events();
5797         let err_msg = match events[0] {
5798                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
5799                         msg.clone()
5800                 },
5801                 _ => panic!("Unexpected event"),
5802         };
5803         assert_eq!(err_msg.data, "dust_limit_satoshis (547) is greater than the implementation limit (546)");
5804 }
5805
5806 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
5807 // originated from our node, its failure is surfaced to the user. We trigger this failure to
5808 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
5809 // is no longer affordable once it's freed.
5810 #[test]
5811 fn test_fail_holding_cell_htlc_upon_free() {
5812         let chanmon_cfgs = create_chanmon_cfgs(2);
5813         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5814         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5815         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5816         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
5817
5818         // First nodes[0] generates an update_fee, setting the channel's
5819         // pending_update_fee.
5820         {
5821                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
5822                 *feerate_lock += 20;
5823         }
5824         nodes[0].node.timer_tick_occurred();
5825         check_added_monitors!(nodes[0], 1);
5826
5827         let events = nodes[0].node.get_and_clear_pending_msg_events();
5828         assert_eq!(events.len(), 1);
5829         let (update_msg, commitment_signed) = match events[0] {
5830                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5831                         (update_fee.as_ref(), commitment_signed)
5832                 },
5833                 _ => panic!("Unexpected event"),
5834         };
5835
5836         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5837
5838         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5839         let channel_reserve = chan_stat.channel_reserve_msat;
5840         let feerate = get_feerate!(nodes[0], chan.2);
5841
5842         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
5843         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
5844         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], max_can_send);
5845
5846         // Send a payment which passes reserve checks but gets stuck in the holding cell.
5847         let our_payment_id = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
5848         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5849         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
5850
5851         // Flush the pending fee update.
5852         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
5853         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5854         check_added_monitors!(nodes[1], 1);
5855         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
5856         check_added_monitors!(nodes[0], 1);
5857
5858         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
5859         // HTLC, but now that the fee has been raised the payment will now fail, causing
5860         // us to surface its failure to the user.
5861         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5862         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
5863         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);
5864         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 {}",
5865                 hex::encode(our_payment_hash.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
5866         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
5867
5868         // Check that the payment failed to be sent out.
5869         let events = nodes[0].node.get_and_clear_pending_events();
5870         assert_eq!(events.len(), 1);
5871         match &events[0] {
5872                 &Event::PaymentPathFailed { ref payment_id, ref payment_hash, ref rejected_by_dest, ref network_update, ref all_paths_failed, ref short_channel_id, ref error_code, ref error_data, .. } => {
5873                         assert_eq!(our_payment_id, *payment_id.as_ref().unwrap());
5874                         assert_eq!(our_payment_hash.clone(), *payment_hash);
5875                         assert_eq!(*rejected_by_dest, false);
5876                         assert_eq!(*all_paths_failed, true);
5877                         assert_eq!(*network_update, None);
5878                         assert_eq!(*short_channel_id, None);
5879                         assert_eq!(*error_code, None);
5880                         assert_eq!(*error_data, None);
5881                 },
5882                 _ => panic!("Unexpected event"),
5883         }
5884 }
5885
5886 // Test that if multiple HTLCs are released from the holding cell and one is
5887 // valid but the other is no longer valid upon release, the valid HTLC can be
5888 // successfully completed while the other one fails as expected.
5889 #[test]
5890 fn test_free_and_fail_holding_cell_htlcs() {
5891         let chanmon_cfgs = create_chanmon_cfgs(2);
5892         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5893         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5894         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5895         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
5896
5897         // First nodes[0] generates an update_fee, setting the channel's
5898         // pending_update_fee.
5899         {
5900                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
5901                 *feerate_lock += 200;
5902         }
5903         nodes[0].node.timer_tick_occurred();
5904         check_added_monitors!(nodes[0], 1);
5905
5906         let events = nodes[0].node.get_and_clear_pending_msg_events();
5907         assert_eq!(events.len(), 1);
5908         let (update_msg, commitment_signed) = match events[0] {
5909                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5910                         (update_fee.as_ref(), commitment_signed)
5911                 },
5912                 _ => panic!("Unexpected event"),
5913         };
5914
5915         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5916
5917         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5918         let channel_reserve = chan_stat.channel_reserve_msat;
5919         let feerate = get_feerate!(nodes[0], chan.2);
5920
5921         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
5922         let amt_1 = 20000;
5923         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
5924         let (route_1, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], amt_1);
5925         let (route_2, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], amt_2);
5926
5927         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
5928         nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
5929         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5930         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
5931         let payment_id_2 = nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
5932         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5933         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
5934
5935         // Flush the pending fee update.
5936         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
5937         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5938         check_added_monitors!(nodes[1], 1);
5939         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
5940         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
5941         check_added_monitors!(nodes[0], 2);
5942
5943         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
5944         // but now that the fee has been raised the second payment will now fail, causing us
5945         // to surface its failure to the user. The first payment should succeed.
5946         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5947         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
5948         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);
5949         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 {}",
5950                 hex::encode(payment_hash_2.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
5951         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
5952
5953         // Check that the second payment failed to be sent out.
5954         let events = nodes[0].node.get_and_clear_pending_events();
5955         assert_eq!(events.len(), 1);
5956         match &events[0] {
5957                 &Event::PaymentPathFailed { ref payment_id, ref payment_hash, ref rejected_by_dest, ref network_update, ref all_paths_failed, ref short_channel_id, ref error_code, ref error_data, .. } => {
5958                         assert_eq!(payment_id_2, *payment_id.as_ref().unwrap());
5959                         assert_eq!(payment_hash_2.clone(), *payment_hash);
5960                         assert_eq!(*rejected_by_dest, false);
5961                         assert_eq!(*all_paths_failed, true);
5962                         assert_eq!(*network_update, None);
5963                         assert_eq!(*short_channel_id, None);
5964                         assert_eq!(*error_code, None);
5965                         assert_eq!(*error_data, None);
5966                 },
5967                 _ => panic!("Unexpected event"),
5968         }
5969
5970         // Complete the first payment and the RAA from the fee update.
5971         let (payment_event, send_raa_event) = {
5972                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
5973                 assert_eq!(msgs.len(), 2);
5974                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
5975         };
5976         let raa = match send_raa_event {
5977                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
5978                 _ => panic!("Unexpected event"),
5979         };
5980         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
5981         check_added_monitors!(nodes[1], 1);
5982         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5983         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5984         let events = nodes[1].node.get_and_clear_pending_events();
5985         assert_eq!(events.len(), 1);
5986         match events[0] {
5987                 Event::PendingHTLCsForwardable { .. } => {},
5988                 _ => panic!("Unexpected event"),
5989         }
5990         nodes[1].node.process_pending_htlc_forwards();
5991         let events = nodes[1].node.get_and_clear_pending_events();
5992         assert_eq!(events.len(), 1);
5993         match events[0] {
5994                 Event::PaymentReceived { .. } => {},
5995                 _ => panic!("Unexpected event"),
5996         }
5997         nodes[1].node.claim_funds(payment_preimage_1);
5998         check_added_monitors!(nodes[1], 1);
5999         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6000         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6001         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6002         let events = nodes[0].node.get_and_clear_pending_events();
6003         assert_eq!(events.len(), 1);
6004         match events[0] {
6005                 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
6006                         assert_eq!(*payment_preimage, payment_preimage_1);
6007                         assert_eq!(*payment_hash, payment_hash_1);
6008                 }
6009                 _ => panic!("Unexpected event"),
6010         }
6011 }
6012
6013 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6014 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6015 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6016 // once it's freed.
6017 #[test]
6018 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6019         let chanmon_cfgs = create_chanmon_cfgs(3);
6020         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6021         // When this test was written, the default base fee floated based on the HTLC count.
6022         // It is now fixed, so we simply set the fee to the expected value here.
6023         let mut config = test_default_channel_config();
6024         config.channel_options.forwarding_fee_base_msat = 196;
6025         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
6026         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6027         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6028         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6029
6030         // First nodes[1] generates an update_fee, setting the channel's
6031         // pending_update_fee.
6032         {
6033                 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
6034                 *feerate_lock += 20;
6035         }
6036         nodes[1].node.timer_tick_occurred();
6037         check_added_monitors!(nodes[1], 1);
6038
6039         let events = nodes[1].node.get_and_clear_pending_msg_events();
6040         assert_eq!(events.len(), 1);
6041         let (update_msg, commitment_signed) = match events[0] {
6042                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6043                         (update_fee.as_ref(), commitment_signed)
6044                 },
6045                 _ => panic!("Unexpected event"),
6046         };
6047
6048         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6049
6050         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6051         let channel_reserve = chan_stat.channel_reserve_msat;
6052         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6053
6054         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6055         let feemsat = 239;
6056         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6057         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6058         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], max_can_send);
6059         let payment_event = {
6060                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6061                 check_added_monitors!(nodes[0], 1);
6062
6063                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6064                 assert_eq!(events.len(), 1);
6065
6066                 SendEvent::from_event(events.remove(0))
6067         };
6068         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6069         check_added_monitors!(nodes[1], 0);
6070         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6071         expect_pending_htlcs_forwardable!(nodes[1]);
6072
6073         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6074         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6075
6076         // Flush the pending fee update.
6077         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6078         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6079         check_added_monitors!(nodes[2], 1);
6080         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6081         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6082         check_added_monitors!(nodes[1], 2);
6083
6084         // A final RAA message is generated to finalize the fee update.
6085         let events = nodes[1].node.get_and_clear_pending_msg_events();
6086         assert_eq!(events.len(), 1);
6087
6088         let raa_msg = match &events[0] {
6089                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6090                         msg.clone()
6091                 },
6092                 _ => panic!("Unexpected event"),
6093         };
6094
6095         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6096         check_added_monitors!(nodes[2], 1);
6097         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6098
6099         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6100         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6101         assert_eq!(process_htlc_forwards_event.len(), 1);
6102         match &process_htlc_forwards_event[0] {
6103                 &Event::PendingHTLCsForwardable { .. } => {},
6104                 _ => panic!("Unexpected event"),
6105         }
6106
6107         // In response, we call ChannelManager's process_pending_htlc_forwards
6108         nodes[1].node.process_pending_htlc_forwards();
6109         check_added_monitors!(nodes[1], 1);
6110
6111         // This causes the HTLC to be failed backwards.
6112         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6113         assert_eq!(fail_event.len(), 1);
6114         let (fail_msg, commitment_signed) = match &fail_event[0] {
6115                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6116                         assert_eq!(updates.update_add_htlcs.len(), 0);
6117                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6118                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6119                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6120                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6121                 },
6122                 _ => panic!("Unexpected event"),
6123         };
6124
6125         // Pass the failure messages back to nodes[0].
6126         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6127         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6128
6129         // Complete the HTLC failure+removal process.
6130         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6131         check_added_monitors!(nodes[0], 1);
6132         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6133         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6134         check_added_monitors!(nodes[1], 2);
6135         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6136         assert_eq!(final_raa_event.len(), 1);
6137         let raa = match &final_raa_event[0] {
6138                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6139                 _ => panic!("Unexpected event"),
6140         };
6141         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6142         expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_1_2.0.contents.short_channel_id, false);
6143         check_added_monitors!(nodes[0], 1);
6144 }
6145
6146 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6147 // 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.
6148 //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.
6149
6150 #[test]
6151 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6152         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6153         let chanmon_cfgs = create_chanmon_cfgs(2);
6154         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6155         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6156         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6157         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6158
6159         let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
6160         route.paths[0][0].fee_msat = 100;
6161
6162         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6163                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6164         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6165         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6166 }
6167
6168 #[test]
6169 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6170         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6171         let chanmon_cfgs = create_chanmon_cfgs(2);
6172         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6173         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6174         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6175         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6176
6177         let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
6178         route.paths[0][0].fee_msat = 0;
6179         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6180                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6181
6182         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6183         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6184 }
6185
6186 #[test]
6187 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6188         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6189         let chanmon_cfgs = create_chanmon_cfgs(2);
6190         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6191         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6192         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6193         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6194
6195         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
6196         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6197         check_added_monitors!(nodes[0], 1);
6198         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6199         updates.update_add_htlcs[0].amount_msat = 0;
6200
6201         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6202         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6203         check_closed_broadcast!(nodes[1], true).unwrap();
6204         check_added_monitors!(nodes[1], 1);
6205         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Remote side tried to send a 0-msat HTLC".to_string() });
6206 }
6207
6208 #[test]
6209 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6210         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6211         //It is enforced when constructing a route.
6212         let chanmon_cfgs = create_chanmon_cfgs(2);
6213         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6214         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6215         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6216         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6217
6218         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], vec![], 100000000, 500000001);
6219         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6220                 assert_eq!(err, &"Channel CLTV overflowed?"));
6221 }
6222
6223 #[test]
6224 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6225         //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.
6226         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6227         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6228         let chanmon_cfgs = create_chanmon_cfgs(2);
6229         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6230         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6231         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6232         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6233         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6234
6235         for i in 0..max_accepted_htlcs {
6236                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
6237                 let payment_event = {
6238                         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6239                         check_added_monitors!(nodes[0], 1);
6240
6241                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6242                         assert_eq!(events.len(), 1);
6243                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6244                                 assert_eq!(htlcs[0].htlc_id, i);
6245                         } else {
6246                                 assert!(false);
6247                         }
6248                         SendEvent::from_event(events.remove(0))
6249                 };
6250                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6251                 check_added_monitors!(nodes[1], 0);
6252                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6253
6254                 expect_pending_htlcs_forwardable!(nodes[1]);
6255                 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6256         }
6257         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
6258         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6259                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6260
6261         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6262         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6263 }
6264
6265 #[test]
6266 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6267         //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.
6268         let chanmon_cfgs = create_chanmon_cfgs(2);
6269         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6270         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6271         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6272         let channel_value = 100000;
6273         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6274         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6275
6276         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6277
6278         let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], max_in_flight);
6279         // Manually create a route over our max in flight (which our router normally automatically
6280         // limits us to.
6281         route.paths[0][0].fee_msat =  max_in_flight + 1;
6282         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6283                 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)));
6284
6285         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6286         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);
6287
6288         send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6289 }
6290
6291 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6292 #[test]
6293 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6294         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6295         let chanmon_cfgs = create_chanmon_cfgs(2);
6296         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6297         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6298         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6299         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6300         let htlc_minimum_msat: u64;
6301         {
6302                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6303                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6304                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6305         }
6306
6307         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], htlc_minimum_msat);
6308         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6309         check_added_monitors!(nodes[0], 1);
6310         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6311         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6312         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6313         assert!(nodes[1].node.list_channels().is_empty());
6314         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6315         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()));
6316         check_added_monitors!(nodes[1], 1);
6317         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6318 }
6319
6320 #[test]
6321 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6322         //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
6323         let chanmon_cfgs = create_chanmon_cfgs(2);
6324         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6325         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6326         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6327         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6328
6329         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6330         let channel_reserve = chan_stat.channel_reserve_msat;
6331         let feerate = get_feerate!(nodes[0], chan.2);
6332         // The 2* and +1 are for the fee spike reserve.
6333         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6334
6335         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6336         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], max_can_send);
6337         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6338         check_added_monitors!(nodes[0], 1);
6339         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6340
6341         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6342         // at this time channel-initiatee receivers are not required to enforce that senders
6343         // respect the fee_spike_reserve.
6344         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6345         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6346
6347         assert!(nodes[1].node.list_channels().is_empty());
6348         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6349         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6350         check_added_monitors!(nodes[1], 1);
6351         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6352 }
6353
6354 #[test]
6355 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6356         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6357         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6358         let chanmon_cfgs = create_chanmon_cfgs(2);
6359         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6360         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6361         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6362         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6363
6364         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3999999);
6365         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6366         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6367         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6368         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height, &None).unwrap();
6369         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6370
6371         let mut msg = msgs::UpdateAddHTLC {
6372                 channel_id: chan.2,
6373                 htlc_id: 0,
6374                 amount_msat: 1000,
6375                 payment_hash: our_payment_hash,
6376                 cltv_expiry: htlc_cltv,
6377                 onion_routing_packet: onion_packet.clone(),
6378         };
6379
6380         for i in 0..super::channel::OUR_MAX_HTLCS {
6381                 msg.htlc_id = i as u64;
6382                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6383         }
6384         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6385         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6386
6387         assert!(nodes[1].node.list_channels().is_empty());
6388         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6389         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6390         check_added_monitors!(nodes[1], 1);
6391         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6392 }
6393
6394 #[test]
6395 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6396         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6397         let chanmon_cfgs = create_chanmon_cfgs(2);
6398         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6399         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6400         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6401         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6402
6403         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6404         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6405         check_added_monitors!(nodes[0], 1);
6406         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6407         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6408         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6409
6410         assert!(nodes[1].node.list_channels().is_empty());
6411         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6412         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6413         check_added_monitors!(nodes[1], 1);
6414         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6415 }
6416
6417 #[test]
6418 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6419         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6420         let chanmon_cfgs = create_chanmon_cfgs(2);
6421         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6422         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6423         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6424
6425         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6426         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6427         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6428         check_added_monitors!(nodes[0], 1);
6429         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6430         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6431         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6432
6433         assert!(nodes[1].node.list_channels().is_empty());
6434         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6435         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6436         check_added_monitors!(nodes[1], 1);
6437         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6438 }
6439
6440 #[test]
6441 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6442         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6443         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6444         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6445         let chanmon_cfgs = create_chanmon_cfgs(2);
6446         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6447         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6448         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6449
6450         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6451         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6452         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6453         check_added_monitors!(nodes[0], 1);
6454         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6455         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6456
6457         //Disconnect and Reconnect
6458         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6459         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6460         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6461         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6462         assert_eq!(reestablish_1.len(), 1);
6463         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6464         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6465         assert_eq!(reestablish_2.len(), 1);
6466         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6467         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6468         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6469         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6470
6471         //Resend HTLC
6472         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6473         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6474         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6475         check_added_monitors!(nodes[1], 1);
6476         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6477
6478         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6479
6480         assert!(nodes[1].node.list_channels().is_empty());
6481         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6482         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6483         check_added_monitors!(nodes[1], 1);
6484         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6485 }
6486
6487 #[test]
6488 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6489         //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.
6490
6491         let chanmon_cfgs = create_chanmon_cfgs(2);
6492         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6493         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6494         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6495         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6496         let (route, our_payment_hash, our_payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6497         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6498
6499         check_added_monitors!(nodes[0], 1);
6500         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6501         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6502
6503         let update_msg = msgs::UpdateFulfillHTLC{
6504                 channel_id: chan.2,
6505                 htlc_id: 0,
6506                 payment_preimage: our_payment_preimage,
6507         };
6508
6509         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6510
6511         assert!(nodes[0].node.list_channels().is_empty());
6512         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6513         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()));
6514         check_added_monitors!(nodes[0], 1);
6515         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6516 }
6517
6518 #[test]
6519 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6520         //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.
6521
6522         let chanmon_cfgs = create_chanmon_cfgs(2);
6523         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6524         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6525         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6526         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6527
6528         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6529         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6530         check_added_monitors!(nodes[0], 1);
6531         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6532         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6533
6534         let update_msg = msgs::UpdateFailHTLC{
6535                 channel_id: chan.2,
6536                 htlc_id: 0,
6537                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6538         };
6539
6540         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6541
6542         assert!(nodes[0].node.list_channels().is_empty());
6543         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6544         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()));
6545         check_added_monitors!(nodes[0], 1);
6546         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6547 }
6548
6549 #[test]
6550 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6551         //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.
6552
6553         let chanmon_cfgs = create_chanmon_cfgs(2);
6554         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6555         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6556         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6557         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6558
6559         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6560         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6561         check_added_monitors!(nodes[0], 1);
6562         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6563         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6564         let update_msg = msgs::UpdateFailMalformedHTLC{
6565                 channel_id: chan.2,
6566                 htlc_id: 0,
6567                 sha256_of_onion: [1; 32],
6568                 failure_code: 0x8000,
6569         };
6570
6571         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6572
6573         assert!(nodes[0].node.list_channels().is_empty());
6574         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6575         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()));
6576         check_added_monitors!(nodes[0], 1);
6577         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6578 }
6579
6580 #[test]
6581 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6582         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6583
6584         let chanmon_cfgs = create_chanmon_cfgs(2);
6585         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6586         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6587         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6588         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6589
6590         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6591
6592         nodes[1].node.claim_funds(our_payment_preimage);
6593         check_added_monitors!(nodes[1], 1);
6594
6595         let events = nodes[1].node.get_and_clear_pending_msg_events();
6596         assert_eq!(events.len(), 1);
6597         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6598                 match events[0] {
6599                         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, .. } } => {
6600                                 assert!(update_add_htlcs.is_empty());
6601                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6602                                 assert!(update_fail_htlcs.is_empty());
6603                                 assert!(update_fail_malformed_htlcs.is_empty());
6604                                 assert!(update_fee.is_none());
6605                                 update_fulfill_htlcs[0].clone()
6606                         },
6607                         _ => panic!("Unexpected event"),
6608                 }
6609         };
6610
6611         update_fulfill_msg.htlc_id = 1;
6612
6613         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6614
6615         assert!(nodes[0].node.list_channels().is_empty());
6616         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6617         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6618         check_added_monitors!(nodes[0], 1);
6619         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6620 }
6621
6622 #[test]
6623 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6624         //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.
6625
6626         let chanmon_cfgs = create_chanmon_cfgs(2);
6627         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6628         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6629         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6630         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6631
6632         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6633
6634         nodes[1].node.claim_funds(our_payment_preimage);
6635         check_added_monitors!(nodes[1], 1);
6636
6637         let events = nodes[1].node.get_and_clear_pending_msg_events();
6638         assert_eq!(events.len(), 1);
6639         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6640                 match events[0] {
6641                         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, .. } } => {
6642                                 assert!(update_add_htlcs.is_empty());
6643                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6644                                 assert!(update_fail_htlcs.is_empty());
6645                                 assert!(update_fail_malformed_htlcs.is_empty());
6646                                 assert!(update_fee.is_none());
6647                                 update_fulfill_htlcs[0].clone()
6648                         },
6649                         _ => panic!("Unexpected event"),
6650                 }
6651         };
6652
6653         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6654
6655         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6656
6657         assert!(nodes[0].node.list_channels().is_empty());
6658         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6659         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6660         check_added_monitors!(nodes[0], 1);
6661         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6662 }
6663
6664 #[test]
6665 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6666         //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.
6667
6668         let chanmon_cfgs = create_chanmon_cfgs(2);
6669         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6670         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6671         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6672         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6673
6674         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6675         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6676         check_added_monitors!(nodes[0], 1);
6677
6678         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6679         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6680
6681         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6682         check_added_monitors!(nodes[1], 0);
6683         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6684
6685         let events = nodes[1].node.get_and_clear_pending_msg_events();
6686
6687         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6688                 match events[0] {
6689                         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, .. } } => {
6690                                 assert!(update_add_htlcs.is_empty());
6691                                 assert!(update_fulfill_htlcs.is_empty());
6692                                 assert!(update_fail_htlcs.is_empty());
6693                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6694                                 assert!(update_fee.is_none());
6695                                 update_fail_malformed_htlcs[0].clone()
6696                         },
6697                         _ => panic!("Unexpected event"),
6698                 }
6699         };
6700         update_msg.failure_code &= !0x8000;
6701         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6702
6703         assert!(nodes[0].node.list_channels().is_empty());
6704         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6705         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6706         check_added_monitors!(nodes[0], 1);
6707         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6708 }
6709
6710 #[test]
6711 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6712         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6713         //    * 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.
6714
6715         let chanmon_cfgs = create_chanmon_cfgs(3);
6716         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6717         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6718         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6719         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6720         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6721
6722         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100000);
6723
6724         //First hop
6725         let mut payment_event = {
6726                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6727                 check_added_monitors!(nodes[0], 1);
6728                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6729                 assert_eq!(events.len(), 1);
6730                 SendEvent::from_event(events.remove(0))
6731         };
6732         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6733         check_added_monitors!(nodes[1], 0);
6734         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6735         expect_pending_htlcs_forwardable!(nodes[1]);
6736         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6737         assert_eq!(events_2.len(), 1);
6738         check_added_monitors!(nodes[1], 1);
6739         payment_event = SendEvent::from_event(events_2.remove(0));
6740         assert_eq!(payment_event.msgs.len(), 1);
6741
6742         //Second Hop
6743         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6744         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6745         check_added_monitors!(nodes[2], 0);
6746         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6747
6748         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6749         assert_eq!(events_3.len(), 1);
6750         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6751                 match events_3[0] {
6752                         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 } } => {
6753                                 assert!(update_add_htlcs.is_empty());
6754                                 assert!(update_fulfill_htlcs.is_empty());
6755                                 assert!(update_fail_htlcs.is_empty());
6756                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6757                                 assert!(update_fee.is_none());
6758                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6759                         },
6760                         _ => panic!("Unexpected event"),
6761                 }
6762         };
6763
6764         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6765
6766         check_added_monitors!(nodes[1], 0);
6767         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6768         expect_pending_htlcs_forwardable!(nodes[1]);
6769         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6770         assert_eq!(events_4.len(), 1);
6771
6772         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6773         match events_4[0] {
6774                 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, .. } } => {
6775                         assert!(update_add_htlcs.is_empty());
6776                         assert!(update_fulfill_htlcs.is_empty());
6777                         assert_eq!(update_fail_htlcs.len(), 1);
6778                         assert!(update_fail_malformed_htlcs.is_empty());
6779                         assert!(update_fee.is_none());
6780                 },
6781                 _ => panic!("Unexpected event"),
6782         };
6783
6784         check_added_monitors!(nodes[1], 1);
6785 }
6786
6787 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6788         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6789         // 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
6790         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6791
6792         let mut chanmon_cfgs = create_chanmon_cfgs(2);
6793         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
6794         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6795         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6796         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6797         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6798
6799         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
6800
6801         // We route 2 dust-HTLCs between A and B
6802         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6803         let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6804         route_payment(&nodes[0], &[&nodes[1]], 1000000);
6805
6806         // Cache one local commitment tx as previous
6807         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6808
6809         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6810         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
6811         check_added_monitors!(nodes[1], 0);
6812         expect_pending_htlcs_forwardable!(nodes[1]);
6813         check_added_monitors!(nodes[1], 1);
6814
6815         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6816         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
6817         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
6818         check_added_monitors!(nodes[0], 1);
6819
6820         // Cache one local commitment tx as lastest
6821         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6822
6823         let events = nodes[0].node.get_and_clear_pending_msg_events();
6824         match events[0] {
6825                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
6826                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6827                 },
6828                 _ => panic!("Unexpected event"),
6829         }
6830         match events[1] {
6831                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
6832                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6833                 },
6834                 _ => panic!("Unexpected event"),
6835         }
6836
6837         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
6838         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
6839         if announce_latest {
6840                 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
6841         } else {
6842                 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
6843         }
6844
6845         check_closed_broadcast!(nodes[0], true);
6846         check_added_monitors!(nodes[0], 1);
6847         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
6848
6849         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6850         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
6851         let events = nodes[0].node.get_and_clear_pending_events();
6852         // Only 2 PaymentPathFailed events should show up, over-dust HTLC has to be failed by timeout tx
6853         assert_eq!(events.len(), 2);
6854         let mut first_failed = false;
6855         for event in events {
6856                 match event {
6857                         Event::PaymentPathFailed { payment_hash, .. } => {
6858                                 if payment_hash == payment_hash_1 {
6859                                         assert!(!first_failed);
6860                                         first_failed = true;
6861                                 } else {
6862                                         assert_eq!(payment_hash, payment_hash_2);
6863                                 }
6864                         }
6865                         _ => panic!("Unexpected event"),
6866                 }
6867         }
6868 }
6869
6870 #[test]
6871 fn test_failure_delay_dust_htlc_local_commitment() {
6872         do_test_failure_delay_dust_htlc_local_commitment(true);
6873         do_test_failure_delay_dust_htlc_local_commitment(false);
6874 }
6875
6876 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
6877         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
6878         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
6879         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
6880         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
6881         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
6882         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
6883
6884         let chanmon_cfgs = create_chanmon_cfgs(3);
6885         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6886         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6887         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6888         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6889
6890         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
6891
6892         let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6893         let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6894
6895         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6896         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
6897
6898         // We revoked bs_commitment_tx
6899         if revoked {
6900                 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6901                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
6902         }
6903
6904         let mut timeout_tx = Vec::new();
6905         if local {
6906                 // We fail dust-HTLC 1 by broadcast of local commitment tx
6907                 mine_transaction(&nodes[0], &as_commitment_tx[0]);
6908                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
6909                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
6910                 expect_payment_failed!(nodes[0], dust_hash, true);
6911
6912                 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
6913                 check_closed_broadcast!(nodes[0], true);
6914                 check_added_monitors!(nodes[0], 1);
6915                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6916                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
6917                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6918                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
6919                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6920                 mine_transaction(&nodes[0], &timeout_tx[0]);
6921                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
6922                 expect_payment_failed!(nodes[0], non_dust_hash, true);
6923         } else {
6924                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
6925                 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
6926                 check_closed_broadcast!(nodes[0], true);
6927                 check_added_monitors!(nodes[0], 1);
6928                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
6929                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6930                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
6931                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
6932                 if !revoked {
6933                         expect_payment_failed!(nodes[0], dust_hash, true);
6934                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
6935                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
6936                         mine_transaction(&nodes[0], &timeout_tx[0]);
6937                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6938                         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
6939                         expect_payment_failed!(nodes[0], non_dust_hash, true);
6940                 } else {
6941                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
6942                         // commitment tx
6943                         let events = nodes[0].node.get_and_clear_pending_events();
6944                         assert_eq!(events.len(), 2);
6945                         let first;
6946                         match events[0] {
6947                                 Event::PaymentPathFailed { payment_hash, .. } => {
6948                                         if payment_hash == dust_hash { first = true; }
6949                                         else { first = false; }
6950                                 },
6951                                 _ => panic!("Unexpected event"),
6952                         }
6953                         match events[1] {
6954                                 Event::PaymentPathFailed { payment_hash, .. } => {
6955                                         if first { assert_eq!(payment_hash, non_dust_hash); }
6956                                         else { assert_eq!(payment_hash, dust_hash); }
6957                                 },
6958                                 _ => panic!("Unexpected event"),
6959                         }
6960                 }
6961         }
6962 }
6963
6964 #[test]
6965 fn test_sweep_outbound_htlc_failure_update() {
6966         do_test_sweep_outbound_htlc_failure_update(false, true);
6967         do_test_sweep_outbound_htlc_failure_update(false, false);
6968         do_test_sweep_outbound_htlc_failure_update(true, false);
6969 }
6970
6971 #[test]
6972 fn test_user_configurable_csv_delay() {
6973         // We test our channel constructors yield errors when we pass them absurd csv delay
6974
6975         let mut low_our_to_self_config = UserConfig::default();
6976         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
6977         let mut high_their_to_self_config = UserConfig::default();
6978         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
6979         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
6980         let chanmon_cfgs = create_chanmon_cfgs(2);
6981         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6982         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
6983         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6984
6985         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
6986         if let Err(error) = Channel::new_outbound(&&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), &InitFeatures::known(), 1000000, 1000000, 0, &low_our_to_self_config) {
6987                 match error {
6988                         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())); },
6989                         _ => panic!("Unexpected event"),
6990                 }
6991         } else { assert!(false) }
6992
6993         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
6994         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6995         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6996         open_channel.to_self_delay = 200;
6997         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), &InitFeatures::known(), &open_channel, 0, &low_our_to_self_config) {
6998                 match error {
6999                         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()));  },
7000                         _ => panic!("Unexpected event"),
7001                 }
7002         } else { assert!(false); }
7003
7004         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7005         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7006         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
7007         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7008         accept_channel.to_self_delay = 200;
7009         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7010         let reason_msg;
7011         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7012                 match action {
7013                         &ErrorAction::SendErrorMessage { ref msg } => {
7014                                 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()));
7015                                 reason_msg = msg.data.clone();
7016                         },
7017                         _ => { panic!(); }
7018                 }
7019         } else { panic!(); }
7020         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: reason_msg });
7021
7022         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7023         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7024         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7025         open_channel.to_self_delay = 200;
7026         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), &InitFeatures::known(), &open_channel, 0, &high_their_to_self_config) {
7027                 match error {
7028                         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())); },
7029                         _ => panic!("Unexpected event"),
7030                 }
7031         } else { assert!(false); }
7032 }
7033
7034 #[test]
7035 fn test_data_loss_protect() {
7036         // We want to be sure that :
7037         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7038         //   (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7039         // * we close channel in case of detecting other being fallen behind
7040         // * we are able to claim our own outputs thanks to to_remote being static
7041         // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7042         let persister;
7043         let logger;
7044         let fee_estimator;
7045         let tx_broadcaster;
7046         let chain_source;
7047         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7048         // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7049         // during signing due to revoked tx
7050         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7051         let keys_manager = &chanmon_cfgs[0].keys_manager;
7052         let monitor;
7053         let node_state_0;
7054         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7055         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7056         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7057
7058         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7059
7060         // Cache node A state before any channel update
7061         let previous_node_state = nodes[0].node.encode();
7062         let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7063         get_monitor!(nodes[0], chan.2).write(&mut previous_chain_monitor_state).unwrap();
7064
7065         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7066         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7067
7068         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7069         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7070
7071         // Restore node A from previous state
7072         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7073         let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7074         chain_source = test_utils::TestChainSource::new(Network::Testnet);
7075         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7076         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
7077         persister = test_utils::TestPersister::new();
7078         monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7079         node_state_0 = {
7080                 let mut channel_monitors = HashMap::new();
7081                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7082                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
7083                         keys_manager: keys_manager,
7084                         fee_estimator: &fee_estimator,
7085                         chain_monitor: &monitor,
7086                         logger: &logger,
7087                         tx_broadcaster: &tx_broadcaster,
7088                         default_config: UserConfig::default(),
7089                         channel_monitors,
7090                 }).unwrap().1
7091         };
7092         nodes[0].node = &node_state_0;
7093         assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7094         nodes[0].chain_monitor = &monitor;
7095         nodes[0].chain_source = &chain_source;
7096
7097         check_added_monitors!(nodes[0], 1);
7098
7099         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7100         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7101
7102         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7103
7104         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7105         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7106         check_added_monitors!(nodes[0], 1);
7107
7108         {
7109                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7110                 assert_eq!(node_txn.len(), 0);
7111         }
7112
7113         let mut reestablish_1 = Vec::with_capacity(1);
7114         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7115                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7116                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7117                         reestablish_1.push(msg.clone());
7118                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7119                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7120                         match action {
7121                                 &ErrorAction::SendErrorMessage { ref msg } => {
7122                                         assert_eq!(msg.data, "We have fallen behind - we have received proof that if we broadcast remote is going to claim our funds - we can't do any automated broadcasting");
7123                                 },
7124                                 _ => panic!("Unexpected event!"),
7125                         }
7126                 } else {
7127                         panic!("Unexpected event")
7128                 }
7129         }
7130
7131         // Check we close channel detecting A is fallen-behind
7132         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7133         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Peer attempted to reestablish channel with a very old local commitment transaction".to_string() });
7134         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7135         check_added_monitors!(nodes[1], 1);
7136
7137         // Check A is able to claim to_remote output
7138         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7139         assert_eq!(node_txn.len(), 1);
7140         check_spends!(node_txn[0], chan.3);
7141         assert_eq!(node_txn[0].output.len(), 2);
7142         mine_transaction(&nodes[0], &node_txn[0]);
7143         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7144         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "We have fallen behind - we have received proof that if we broadcast remote is going to claim our funds - we can\'t do any automated broadcasting".to_string() });
7145         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
7146         assert_eq!(spend_txn.len(), 1);
7147         check_spends!(spend_txn[0], node_txn[0]);
7148 }
7149
7150 #[test]
7151 fn test_check_htlc_underpaying() {
7152         // Send payment through A -> B but A is maliciously
7153         // sending a probe payment (i.e less than expected value0
7154         // to B, B should refuse payment.
7155
7156         let chanmon_cfgs = create_chanmon_cfgs(2);
7157         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7158         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7159         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7160
7161         // Create some initial channels
7162         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7163
7164         let scorer = Scorer::with_fixed_penalty(0);
7165         let payee = Payee::new(nodes[1].node.get_our_node_id()).with_features(InvoiceFeatures::known());
7166         let route = get_route(&nodes[0].node.get_our_node_id(), &payee, &nodes[0].net_graph_msg_handler.network_graph, None, 10_000, TEST_FINAL_CLTV, nodes[0].logger, &scorer).unwrap();
7167         let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7168         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7169         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7170         check_added_monitors!(nodes[0], 1);
7171
7172         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7173         assert_eq!(events.len(), 1);
7174         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7175         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7176         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7177
7178         // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7179         // and then will wait a second random delay before failing the HTLC back:
7180         expect_pending_htlcs_forwardable!(nodes[1]);
7181         expect_pending_htlcs_forwardable!(nodes[1]);
7182
7183         // Node 3 is expecting payment of 100_000 but received 10_000,
7184         // it should fail htlc like we didn't know the preimage.
7185         nodes[1].node.process_pending_htlc_forwards();
7186
7187         let events = nodes[1].node.get_and_clear_pending_msg_events();
7188         assert_eq!(events.len(), 1);
7189         let (update_fail_htlc, commitment_signed) = match events[0] {
7190                 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 } } => {
7191                         assert!(update_add_htlcs.is_empty());
7192                         assert!(update_fulfill_htlcs.is_empty());
7193                         assert_eq!(update_fail_htlcs.len(), 1);
7194                         assert!(update_fail_malformed_htlcs.is_empty());
7195                         assert!(update_fee.is_none());
7196                         (update_fail_htlcs[0].clone(), commitment_signed)
7197                 },
7198                 _ => panic!("Unexpected event"),
7199         };
7200         check_added_monitors!(nodes[1], 1);
7201
7202         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7203         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7204
7205         // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7206         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7207         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7208         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7209 }
7210
7211 #[test]
7212 fn test_announce_disable_channels() {
7213         // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7214         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7215
7216         let chanmon_cfgs = create_chanmon_cfgs(2);
7217         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7218         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7219         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7220
7221         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7222         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7223         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7224
7225         // Disconnect peers
7226         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7227         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7228
7229         nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7230         nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7231         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7232         assert_eq!(msg_events.len(), 3);
7233         let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7234         for e in msg_events {
7235                 match e {
7236                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7237                                 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7238                                 // Check that each channel gets updated exactly once
7239                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7240                                         panic!("Generated ChannelUpdate for wrong chan!");
7241                                 }
7242                         },
7243                         _ => panic!("Unexpected event"),
7244                 }
7245         }
7246         // Reconnect peers
7247         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7248         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7249         assert_eq!(reestablish_1.len(), 3);
7250         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7251         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7252         assert_eq!(reestablish_2.len(), 3);
7253
7254         // Reestablish chan_1
7255         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7256         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7257         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7258         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7259         // Reestablish chan_2
7260         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7261         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7262         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7263         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7264         // Reestablish chan_3
7265         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7266         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7267         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7268         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7269
7270         nodes[0].node.timer_tick_occurred();
7271         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7272         nodes[0].node.timer_tick_occurred();
7273         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7274         assert_eq!(msg_events.len(), 3);
7275         chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7276         for e in msg_events {
7277                 match e {
7278                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7279                                 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7280                                 // Check that each channel gets updated exactly once
7281                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7282                                         panic!("Generated ChannelUpdate for wrong chan!");
7283                                 }
7284                         },
7285                         _ => panic!("Unexpected event"),
7286                 }
7287         }
7288 }
7289
7290 #[test]
7291 fn test_priv_forwarding_rejection() {
7292         // If we have a private channel with outbound liquidity, and
7293         // UserConfig::accept_forwards_to_priv_channels is set to false, we should reject any attempts
7294         // to forward through that channel.
7295         let chanmon_cfgs = create_chanmon_cfgs(3);
7296         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7297         let mut no_announce_cfg = test_default_channel_config();
7298         no_announce_cfg.channel_options.announced_channel = false;
7299         no_announce_cfg.accept_forwards_to_priv_channels = false;
7300         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(no_announce_cfg), None]);
7301         let persister: test_utils::TestPersister;
7302         let new_chain_monitor: test_utils::TestChainMonitor;
7303         let nodes_1_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
7304         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7305
7306         let chan_id_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known()).2;
7307
7308         // Note that the create_*_chan functions in utils requires announcement_signatures, which we do
7309         // not send for private channels.
7310         nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
7311         let open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[2].node.get_our_node_id());
7312         nodes[2].node.handle_open_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel);
7313         let accept_channel = get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[1].node.get_our_node_id());
7314         nodes[1].node.handle_accept_channel(&nodes[2].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7315
7316         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[1], 1_000_000, 42);
7317         nodes[1].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
7318         nodes[2].node.handle_funding_created(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingCreated, nodes[2].node.get_our_node_id()));
7319         check_added_monitors!(nodes[2], 1);
7320
7321         let cs_funding_signed = get_event_msg!(nodes[2], MessageSendEvent::SendFundingSigned, nodes[1].node.get_our_node_id());
7322         nodes[1].node.handle_funding_signed(&nodes[2].node.get_our_node_id(), &cs_funding_signed);
7323         check_added_monitors!(nodes[1], 1);
7324
7325         let conf_height = core::cmp::max(nodes[1].best_block_info().1 + 1, nodes[2].best_block_info().1 + 1);
7326         confirm_transaction_at(&nodes[1], &tx, conf_height);
7327         connect_blocks(&nodes[1], CHAN_CONFIRM_DEPTH - 1);
7328         confirm_transaction_at(&nodes[2], &tx, conf_height);
7329         connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1);
7330         let as_funding_locked = get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[2].node.get_our_node_id());
7331         nodes[1].node.handle_funding_locked(&nodes[2].node.get_our_node_id(), &get_event_msg!(nodes[2], MessageSendEvent::SendFundingLocked, nodes[1].node.get_our_node_id()));
7332         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
7333         nodes[2].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &as_funding_locked);
7334         get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7335
7336         assert!(nodes[0].node.list_usable_channels()[0].is_public);
7337         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
7338         assert!(!nodes[2].node.list_usable_channels()[0].is_public);
7339
7340         // We should always be able to forward through nodes[1] as long as its out through a public
7341         // channel:
7342         send_payment(&nodes[2], &[&nodes[1], &nodes[0]], 10_000);
7343
7344         // ... however, if we send to nodes[2], we will have to pass the private channel from nodes[1]
7345         // to nodes[2], which should be rejected:
7346         let route_hint = RouteHint(vec![RouteHintHop {
7347                 src_node_id: nodes[1].node.get_our_node_id(),
7348                 short_channel_id: nodes[2].node.list_channels()[0].short_channel_id.unwrap(),
7349                 fees: RoutingFees { base_msat: 1000, proportional_millionths: 0 },
7350                 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
7351                 htlc_minimum_msat: None,
7352                 htlc_maximum_msat: None,
7353         }]);
7354         let last_hops = vec![route_hint];
7355         let (route, our_payment_hash, our_payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], last_hops, 10_000, TEST_FINAL_CLTV);
7356
7357         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7358         check_added_monitors!(nodes[0], 1);
7359         let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
7360         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7361         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true);
7362
7363         let htlc_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7364         assert!(htlc_fail_updates.update_add_htlcs.is_empty());
7365         assert_eq!(htlc_fail_updates.update_fail_htlcs.len(), 1);
7366         assert!(htlc_fail_updates.update_fail_malformed_htlcs.is_empty());
7367         assert!(htlc_fail_updates.update_fee.is_none());
7368
7369         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates.update_fail_htlcs[0]);
7370         commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates.commitment_signed, true, true);
7371         expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, nodes[2].node.list_channels()[0].short_channel_id.unwrap(), true);
7372
7373         // Now disconnect nodes[1] from its peers and restart with accept_forwards_to_priv_channels set
7374         // to true. Sadly there is currently no way to change it at runtime.
7375
7376         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7377         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7378
7379         let nodes_1_serialized = nodes[1].node.encode();
7380         let mut monitor_a_serialized = test_utils::TestVecWriter(Vec::new());
7381         let mut monitor_b_serialized = test_utils::TestVecWriter(Vec::new());
7382         get_monitor!(nodes[1], chan_id_1).write(&mut monitor_a_serialized).unwrap();
7383         get_monitor!(nodes[1], cs_funding_signed.channel_id).write(&mut monitor_b_serialized).unwrap();
7384
7385         persister = test_utils::TestPersister::new();
7386         let keys_manager = &chanmon_cfgs[1].keys_manager;
7387         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[1].chain_source), nodes[1].tx_broadcaster.clone(), nodes[1].logger, node_cfgs[1].fee_estimator, &persister, keys_manager);
7388         nodes[1].chain_monitor = &new_chain_monitor;
7389
7390         let mut monitor_a_read = &monitor_a_serialized.0[..];
7391         let mut monitor_b_read = &monitor_b_serialized.0[..];
7392         let (_, mut monitor_a) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_a_read, keys_manager).unwrap();
7393         let (_, mut monitor_b) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_b_read, keys_manager).unwrap();
7394         assert!(monitor_a_read.is_empty());
7395         assert!(monitor_b_read.is_empty());
7396
7397         no_announce_cfg.accept_forwards_to_priv_channels = true;
7398
7399         let mut nodes_1_read = &nodes_1_serialized[..];
7400         let (_, nodes_1_deserialized_tmp) = {
7401                 let mut channel_monitors = HashMap::new();
7402                 channel_monitors.insert(monitor_a.get_funding_txo().0, &mut monitor_a);
7403                 channel_monitors.insert(monitor_b.get_funding_txo().0, &mut monitor_b);
7404                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_1_read, ChannelManagerReadArgs {
7405                         default_config: no_announce_cfg,
7406                         keys_manager,
7407                         fee_estimator: node_cfgs[1].fee_estimator,
7408                         chain_monitor: nodes[1].chain_monitor,
7409                         tx_broadcaster: nodes[1].tx_broadcaster.clone(),
7410                         logger: nodes[1].logger,
7411                         channel_monitors,
7412                 }).unwrap()
7413         };
7414         assert!(nodes_1_read.is_empty());
7415         nodes_1_deserialized = nodes_1_deserialized_tmp;
7416
7417         assert!(nodes[1].chain_monitor.watch_channel(monitor_a.get_funding_txo().0, monitor_a).is_ok());
7418         assert!(nodes[1].chain_monitor.watch_channel(monitor_b.get_funding_txo().0, monitor_b).is_ok());
7419         check_added_monitors!(nodes[1], 2);
7420         nodes[1].node = &nodes_1_deserialized;
7421
7422         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
7423         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7424         let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
7425         let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
7426         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
7427         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
7428         get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7429         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
7430
7431         nodes[1].node.peer_connected(&nodes[2].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
7432         nodes[2].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7433         let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[2].node.get_our_node_id());
7434         let cs_reestablish = get_event_msg!(nodes[2], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
7435         nodes[2].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
7436         nodes[1].node.handle_channel_reestablish(&nodes[2].node.get_our_node_id(), &cs_reestablish);
7437         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
7438         get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7439
7440         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7441         check_added_monitors!(nodes[0], 1);
7442         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 10_000, our_payment_hash, our_payment_secret);
7443         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], our_payment_preimage);
7444 }
7445
7446 #[test]
7447 fn test_bump_penalty_txn_on_revoked_commitment() {
7448         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7449         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7450
7451         let chanmon_cfgs = create_chanmon_cfgs(2);
7452         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7453         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7454         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7455
7456         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7457
7458         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7459         let (route,_, _, _) = get_route_and_payment_hash!(nodes[1], nodes[0], vec![], 3000000, 30);
7460         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7461
7462         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7463         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7464         assert_eq!(revoked_txn[0].output.len(), 4);
7465         assert_eq!(revoked_txn[0].input.len(), 1);
7466         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7467         let revoked_txid = revoked_txn[0].txid();
7468
7469         let mut penalty_sum = 0;
7470         for outp in revoked_txn[0].output.iter() {
7471                 if outp.script_pubkey.is_v0_p2wsh() {
7472                         penalty_sum += outp.value;
7473                 }
7474         }
7475
7476         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7477         let header_114 = connect_blocks(&nodes[1], 14);
7478
7479         // Actually revoke tx by claiming a HTLC
7480         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7481         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7482         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7483         check_added_monitors!(nodes[1], 1);
7484
7485         // One or more justice tx should have been broadcast, check it
7486         let penalty_1;
7487         let feerate_1;
7488         {
7489                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7490                 assert_eq!(node_txn.len(), 2); // justice tx (broadcasted from ChannelMonitor) + local commitment tx
7491                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7492                 assert_eq!(node_txn[0].output.len(), 1);
7493                 check_spends!(node_txn[0], revoked_txn[0]);
7494                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7495                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7496                 penalty_1 = node_txn[0].txid();
7497                 node_txn.clear();
7498         };
7499
7500         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7501         connect_blocks(&nodes[1], 15);
7502         let mut penalty_2 = penalty_1;
7503         let mut feerate_2 = 0;
7504         {
7505                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7506                 assert_eq!(node_txn.len(), 1);
7507                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7508                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7509                         assert_eq!(node_txn[0].output.len(), 1);
7510                         check_spends!(node_txn[0], revoked_txn[0]);
7511                         penalty_2 = node_txn[0].txid();
7512                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7513                         assert_ne!(penalty_2, penalty_1);
7514                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7515                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7516                         // Verify 25% bump heuristic
7517                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7518                         node_txn.clear();
7519                 }
7520         }
7521         assert_ne!(feerate_2, 0);
7522
7523         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7524         connect_blocks(&nodes[1], 1);
7525         let penalty_3;
7526         let mut feerate_3 = 0;
7527         {
7528                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7529                 assert_eq!(node_txn.len(), 1);
7530                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7531                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7532                         assert_eq!(node_txn[0].output.len(), 1);
7533                         check_spends!(node_txn[0], revoked_txn[0]);
7534                         penalty_3 = node_txn[0].txid();
7535                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7536                         assert_ne!(penalty_3, penalty_2);
7537                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7538                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7539                         // Verify 25% bump heuristic
7540                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7541                         node_txn.clear();
7542                 }
7543         }
7544         assert_ne!(feerate_3, 0);
7545
7546         nodes[1].node.get_and_clear_pending_events();
7547         nodes[1].node.get_and_clear_pending_msg_events();
7548 }
7549
7550 #[test]
7551 fn test_bump_penalty_txn_on_revoked_htlcs() {
7552         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7553         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7554
7555         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7556         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
7557         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7558         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7559         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7560
7561         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7562         // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
7563         let payee = Payee::new(nodes[1].node.get_our_node_id()).with_features(InvoiceFeatures::known());
7564         let scorer = Scorer::with_fixed_penalty(0);
7565         let route = get_route(&nodes[0].node.get_our_node_id(), &payee, &nodes[0].net_graph_msg_handler.network_graph,
7566                 None, 3_000_000, 50, nodes[0].logger, &scorer).unwrap();
7567         let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
7568         let payee = Payee::new(nodes[0].node.get_our_node_id()).with_features(InvoiceFeatures::known());
7569         let route = get_route(&nodes[1].node.get_our_node_id(), &payee, &nodes[1].net_graph_msg_handler.network_graph,
7570                 None, 3_000_000, 50, nodes[0].logger, &scorer).unwrap();
7571         send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
7572
7573         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7574         assert_eq!(revoked_local_txn[0].input.len(), 1);
7575         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7576
7577         // Revoke local commitment tx
7578         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7579
7580         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7581         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7582         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
7583         check_closed_broadcast!(nodes[1], true);
7584         check_added_monitors!(nodes[1], 1);
7585         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
7586         connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
7587
7588         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7589         assert_eq!(revoked_htlc_txn.len(), 3);
7590         check_spends!(revoked_htlc_txn[1], chan.3);
7591
7592         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7593         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7594         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7595
7596         assert_eq!(revoked_htlc_txn[2].input.len(), 1);
7597         assert_eq!(revoked_htlc_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7598         assert_eq!(revoked_htlc_txn[2].output.len(), 1);
7599         check_spends!(revoked_htlc_txn[2], revoked_local_txn[0]);
7600
7601         // Broadcast set of revoked txn on A
7602         let hash_128 = connect_blocks(&nodes[0], 40);
7603         let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7604         connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
7605         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7606         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[2].clone()] });
7607         let events = nodes[0].node.get_and_clear_pending_events();
7608         expect_pending_htlcs_forwardable_from_events!(nodes[0], events[0..1], true);
7609         match events[1] {
7610                 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
7611                 _ => panic!("Unexpected event"),
7612         }
7613         let first;
7614         let feerate_1;
7615         let penalty_txn;
7616         {
7617                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7618                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7619                 // Verify claim tx are spending revoked HTLC txn
7620
7621                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
7622                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
7623                 // which are included in the same block (they are broadcasted because we scan the
7624                 // transactions linearly and generate claims as we go, they likely should be removed in the
7625                 // future).
7626                 assert_eq!(node_txn[0].input.len(), 1);
7627                 check_spends!(node_txn[0], revoked_local_txn[0]);
7628                 assert_eq!(node_txn[1].input.len(), 1);
7629                 check_spends!(node_txn[1], revoked_local_txn[0]);
7630                 assert_eq!(node_txn[2].input.len(), 1);
7631                 check_spends!(node_txn[2], revoked_local_txn[0]);
7632
7633                 // Each of the three justice transactions claim a separate (single) output of the three
7634                 // available, which we check here:
7635                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
7636                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
7637                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
7638
7639                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7640                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
7641
7642                 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
7643                 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
7644                 // a remote commitment tx has already been confirmed).
7645                 check_spends!(node_txn[3], chan.3);
7646
7647                 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
7648                 // output, checked above).
7649                 assert_eq!(node_txn[4].input.len(), 2);
7650                 assert_eq!(node_txn[4].output.len(), 1);
7651                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[2]);
7652
7653                 first = node_txn[4].txid();
7654                 // Store both feerates for later comparison
7655                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[4].output[0].value;
7656                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7657                 penalty_txn = vec![node_txn[2].clone()];
7658                 node_txn.clear();
7659         }
7660
7661         // Connect one more block to see if bumped penalty are issued for HTLC txn
7662         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7663         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
7664         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7665         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
7666         {
7667                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7668                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7669
7670                 check_spends!(node_txn[0], revoked_local_txn[0]);
7671                 check_spends!(node_txn[1], revoked_local_txn[0]);
7672                 // Note that these are both bogus - they spend outputs already claimed in block 129:
7673                 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output  {
7674                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
7675                 } else {
7676                         assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
7677                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7678                 }
7679
7680                 node_txn.clear();
7681         };
7682
7683         // Few more blocks to confirm penalty txn
7684         connect_blocks(&nodes[0], 4);
7685         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7686         let header_144 = connect_blocks(&nodes[0], 9);
7687         let node_txn = {
7688                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7689                 assert_eq!(node_txn.len(), 1);
7690
7691                 assert_eq!(node_txn[0].input.len(), 2);
7692                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[2]);
7693                 // Verify bumped tx is different and 25% bump heuristic
7694                 assert_ne!(first, node_txn[0].txid());
7695                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[0].output[0].value;
7696                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7697                 assert!(feerate_2 * 100 > feerate_1 * 125);
7698                 let txn = vec![node_txn[0].clone()];
7699                 node_txn.clear();
7700                 txn
7701         };
7702         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7703         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7704         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
7705         connect_blocks(&nodes[0], 20);
7706         {
7707                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7708                 // We verify than no new transaction has been broadcast because previously
7709                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7710                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7711                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7712                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7713                 // up bumped justice generation.
7714                 assert_eq!(node_txn.len(), 0);
7715                 node_txn.clear();
7716         }
7717         check_closed_broadcast!(nodes[0], true);
7718         check_added_monitors!(nodes[0], 1);
7719 }
7720
7721 #[test]
7722 fn test_bump_penalty_txn_on_remote_commitment() {
7723         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7724         // we're able to claim outputs on remote commitment transaction before timelocks expiration
7725
7726         // Create 2 HTLCs
7727         // Provide preimage for one
7728         // Check aggregation
7729
7730         let chanmon_cfgs = create_chanmon_cfgs(2);
7731         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7732         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7733         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7734
7735         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7736         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7737         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7738
7739         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7740         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7741         assert_eq!(remote_txn[0].output.len(), 4);
7742         assert_eq!(remote_txn[0].input.len(), 1);
7743         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7744
7745         // Claim a HTLC without revocation (provide B monitor with preimage)
7746         nodes[1].node.claim_funds(payment_preimage);
7747         mine_transaction(&nodes[1], &remote_txn[0]);
7748         check_added_monitors!(nodes[1], 2);
7749         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7750
7751         // One or more claim tx should have been broadcast, check it
7752         let timeout;
7753         let preimage;
7754         let preimage_bump;
7755         let feerate_timeout;
7756         let feerate_preimage;
7757         {
7758                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7759                 // 9 transactions including:
7760                 // 1*2 ChannelManager local broadcasts of commitment + HTLC-Success
7761                 // 1*3 ChannelManager local broadcasts of commitment + HTLC-Success + HTLC-Timeout
7762                 // 2 * HTLC-Success (one RBF bump we'll check later)
7763                 // 1 * HTLC-Timeout
7764                 assert_eq!(node_txn.len(), 8);
7765                 assert_eq!(node_txn[0].input.len(), 1);
7766                 assert_eq!(node_txn[6].input.len(), 1);
7767                 check_spends!(node_txn[0], remote_txn[0]);
7768                 check_spends!(node_txn[6], remote_txn[0]);
7769                 assert_eq!(node_txn[0].input[0].previous_output, node_txn[3].input[0].previous_output);
7770                 preimage_bump = node_txn[3].clone();
7771
7772                 check_spends!(node_txn[1], chan.3);
7773                 check_spends!(node_txn[2], node_txn[1]);
7774                 assert_eq!(node_txn[1], node_txn[4]);
7775                 assert_eq!(node_txn[2], node_txn[5]);
7776
7777                 timeout = node_txn[6].txid();
7778                 let index = node_txn[6].input[0].previous_output.vout;
7779                 let fee = remote_txn[0].output[index as usize].value - node_txn[6].output[0].value;
7780                 feerate_timeout = fee * 1000 / node_txn[6].get_weight() as u64;
7781
7782                 preimage = node_txn[0].txid();
7783                 let index = node_txn[0].input[0].previous_output.vout;
7784                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7785                 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
7786
7787                 node_txn.clear();
7788         };
7789         assert_ne!(feerate_timeout, 0);
7790         assert_ne!(feerate_preimage, 0);
7791
7792         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7793         connect_blocks(&nodes[1], 15);
7794         {
7795                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7796                 assert_eq!(node_txn.len(), 1);
7797                 assert_eq!(node_txn[0].input.len(), 1);
7798                 assert_eq!(preimage_bump.input.len(), 1);
7799                 check_spends!(node_txn[0], remote_txn[0]);
7800                 check_spends!(preimage_bump, remote_txn[0]);
7801
7802                 let index = preimage_bump.input[0].previous_output.vout;
7803                 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
7804                 let new_feerate = fee * 1000 / preimage_bump.get_weight() as u64;
7805                 assert!(new_feerate * 100 > feerate_timeout * 125);
7806                 assert_ne!(timeout, preimage_bump.txid());
7807
7808                 let index = node_txn[0].input[0].previous_output.vout;
7809                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7810                 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7811                 assert!(new_feerate * 100 > feerate_preimage * 125);
7812                 assert_ne!(preimage, node_txn[0].txid());
7813
7814                 node_txn.clear();
7815         }
7816
7817         nodes[1].node.get_and_clear_pending_events();
7818         nodes[1].node.get_and_clear_pending_msg_events();
7819 }
7820
7821 #[test]
7822 fn test_counterparty_raa_skip_no_crash() {
7823         // Previously, if our counterparty sent two RAAs in a row without us having provided a
7824         // commitment transaction, we would have happily carried on and provided them the next
7825         // commitment transaction based on one RAA forward. This would probably eventually have led to
7826         // channel closure, but it would not have resulted in funds loss. Still, our
7827         // EnforcingSigner would have panicked as it doesn't like jumps into the future. Here, we
7828         // check simply that the channel is closed in response to such an RAA, but don't check whether
7829         // we decide to punish our counterparty for revoking their funds (as we don't currently
7830         // implement that).
7831         let chanmon_cfgs = create_chanmon_cfgs(2);
7832         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7833         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7834         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7835         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
7836
7837         let mut guard = nodes[0].node.channel_state.lock().unwrap();
7838         let keys = guard.by_id.get_mut(&channel_id).unwrap().get_signer();
7839
7840         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7841
7842         // Make signer believe we got a counterparty signature, so that it allows the revocation
7843         keys.get_enforcement_state().last_holder_commitment -= 1;
7844         let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
7845
7846         // Must revoke without gaps
7847         keys.get_enforcement_state().last_holder_commitment -= 1;
7848         keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
7849
7850         keys.get_enforcement_state().last_holder_commitment -= 1;
7851         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7852                 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7853
7854         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7855                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
7856         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7857         check_added_monitors!(nodes[1], 1);
7858         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Received an unexpected revoke_and_ack".to_string() });
7859 }
7860
7861 #[test]
7862 fn test_bump_txn_sanitize_tracking_maps() {
7863         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7864         // verify we clean then right after expiration of ANTI_REORG_DELAY.
7865
7866         let chanmon_cfgs = create_chanmon_cfgs(2);
7867         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7868         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7869         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7870
7871         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7872         // Lock HTLC in both directions
7873         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
7874         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
7875
7876         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7877         assert_eq!(revoked_local_txn[0].input.len(), 1);
7878         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7879
7880         // Revoke local commitment tx
7881         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7882
7883         // Broadcast set of revoked txn on A
7884         connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
7885         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7886         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
7887
7888         mine_transaction(&nodes[0], &revoked_local_txn[0]);
7889         check_closed_broadcast!(nodes[0], true);
7890         check_added_monitors!(nodes[0], 1);
7891         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
7892         let penalty_txn = {
7893                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7894                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
7895                 check_spends!(node_txn[0], revoked_local_txn[0]);
7896                 check_spends!(node_txn[1], revoked_local_txn[0]);
7897                 check_spends!(node_txn[2], revoked_local_txn[0]);
7898                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7899                 node_txn.clear();
7900                 penalty_txn
7901         };
7902         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7903         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
7904         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7905         {
7906                 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(OutPoint { txid: chan.3.txid(), index: 0 }).unwrap();
7907                 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
7908                 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
7909         }
7910 }
7911
7912 #[test]
7913 fn test_override_channel_config() {
7914         let chanmon_cfgs = create_chanmon_cfgs(2);
7915         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7916         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7917         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7918
7919         // Node0 initiates a channel to node1 using the override config.
7920         let mut override_config = UserConfig::default();
7921         override_config.own_channel_config.our_to_self_delay = 200;
7922
7923         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
7924
7925         // Assert the channel created by node0 is using the override config.
7926         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7927         assert_eq!(res.channel_flags, 0);
7928         assert_eq!(res.to_self_delay, 200);
7929 }
7930
7931 #[test]
7932 fn test_override_0msat_htlc_minimum() {
7933         let mut zero_config = UserConfig::default();
7934         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
7935         let chanmon_cfgs = create_chanmon_cfgs(2);
7936         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7937         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
7938         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7939
7940         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
7941         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7942         assert_eq!(res.htlc_minimum_msat, 1);
7943
7944         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
7945         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7946         assert_eq!(res.htlc_minimum_msat, 1);
7947 }
7948
7949 #[test]
7950 fn test_simple_mpp() {
7951         // Simple test of sending a multi-path payment.
7952         let chanmon_cfgs = create_chanmon_cfgs(4);
7953         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
7954         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
7955         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
7956
7957         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7958         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7959         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7960         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7961
7962         let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
7963         let path = route.paths[0].clone();
7964         route.paths.push(path);
7965         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
7966         route.paths[0][0].short_channel_id = chan_1_id;
7967         route.paths[0][1].short_channel_id = chan_3_id;
7968         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
7969         route.paths[1][0].short_channel_id = chan_2_id;
7970         route.paths[1][1].short_channel_id = chan_4_id;
7971         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
7972         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
7973 }
7974
7975 #[test]
7976 fn test_preimage_storage() {
7977         // Simple test of payment preimage storage allowing no client-side storage to claim payments
7978         let chanmon_cfgs = create_chanmon_cfgs(2);
7979         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7980         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7981         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7982
7983         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7984
7985         {
7986                 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
7987                 let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
7988                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
7989                 check_added_monitors!(nodes[0], 1);
7990                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7991                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7992                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7993                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7994         }
7995         // Note that after leaving the above scope we have no knowledge of any arguments or return
7996         // values from previous calls.
7997         expect_pending_htlcs_forwardable!(nodes[1]);
7998         let events = nodes[1].node.get_and_clear_pending_events();
7999         assert_eq!(events.len(), 1);
8000         match events[0] {
8001                 Event::PaymentReceived { ref purpose, .. } => {
8002                         match &purpose {
8003                                 PaymentPurpose::InvoicePayment { payment_preimage, user_payment_id, .. } => {
8004                                         assert_eq!(*user_payment_id, 42);
8005                                         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8006                                 },
8007                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
8008                         }
8009                 },
8010                 _ => panic!("Unexpected event"),
8011         }
8012 }
8013
8014 #[test]
8015 fn test_secret_timeout() {
8016         // Simple test of payment secret storage time outs
8017         let chanmon_cfgs = create_chanmon_cfgs(2);
8018         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8019         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8020         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8021
8022         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8023
8024         let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8025
8026         // We should fail to register the same payment hash twice, at least until we've connected a
8027         // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8028         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8029                 assert_eq!(err, "Duplicate payment hash");
8030         } else { panic!(); }
8031         let mut block = {
8032                 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8033                 Block {
8034                         header: BlockHeader {
8035                                 version: 0x2000000,
8036                                 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8037                                 merkle_root: Default::default(),
8038                                 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8039                         txdata: vec![],
8040                 }
8041         };
8042         connect_block(&nodes[1], &block);
8043         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8044                 assert_eq!(err, "Duplicate payment hash");
8045         } else { panic!(); }
8046
8047         // If we then connect the second block, we should be able to register the same payment hash
8048         // again with a different user_payment_id (this time getting a new payment secret).
8049         block.header.prev_blockhash = block.header.block_hash();
8050         block.header.time += 1;
8051         connect_block(&nodes[1], &block);
8052         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8053         assert_ne!(payment_secret_1, our_payment_secret);
8054
8055         {
8056                 let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
8057                 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8058                 check_added_monitors!(nodes[0], 1);
8059                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8060                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8061                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8062                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8063         }
8064         // Note that after leaving the above scope we have no knowledge of any arguments or return
8065         // values from previous calls.
8066         expect_pending_htlcs_forwardable!(nodes[1]);
8067         let events = nodes[1].node.get_and_clear_pending_events();
8068         assert_eq!(events.len(), 1);
8069         match events[0] {
8070                 Event::PaymentReceived { purpose: PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, user_payment_id }, .. } => {
8071                         assert!(payment_preimage.is_none());
8072                         assert_eq!(user_payment_id, 42);
8073                         assert_eq!(payment_secret, our_payment_secret);
8074                         // We don't actually have the payment preimage with which to claim this payment!
8075                 },
8076                 _ => panic!("Unexpected event"),
8077         }
8078 }
8079
8080 #[test]
8081 fn test_bad_secret_hash() {
8082         // Simple test of unregistered payment hash/invalid payment secret handling
8083         let chanmon_cfgs = create_chanmon_cfgs(2);
8084         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8085         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8086         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8087
8088         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8089
8090         let random_payment_hash = PaymentHash([42; 32]);
8091         let random_payment_secret = PaymentSecret([43; 32]);
8092         let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8093         let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
8094
8095         // All the below cases should end up being handled exactly identically, so we macro the
8096         // resulting events.
8097         macro_rules! handle_unknown_invalid_payment_data {
8098                 () => {
8099                         check_added_monitors!(nodes[0], 1);
8100                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8101                         let payment_event = SendEvent::from_event(events.pop().unwrap());
8102                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8103                         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8104
8105                         // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8106                         // again to process the pending backwards-failure of the HTLC
8107                         expect_pending_htlcs_forwardable!(nodes[1]);
8108                         expect_pending_htlcs_forwardable!(nodes[1]);
8109                         check_added_monitors!(nodes[1], 1);
8110
8111                         // We should fail the payment back
8112                         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8113                         match events.pop().unwrap() {
8114                                 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8115                                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8116                                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8117                                 },
8118                                 _ => panic!("Unexpected event"),
8119                         }
8120                 }
8121         }
8122
8123         let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8124         // Error data is the HTLC value (100,000) and current block height
8125         let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8126
8127         // Send a payment with the right payment hash but the wrong payment secret
8128         nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8129         handle_unknown_invalid_payment_data!();
8130         expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8131
8132         // Send a payment with a random payment hash, but the right payment secret
8133         nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8134         handle_unknown_invalid_payment_data!();
8135         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8136
8137         // Send a payment with a random payment hash and random payment secret
8138         nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8139         handle_unknown_invalid_payment_data!();
8140         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8141 }
8142
8143 #[test]
8144 fn test_update_err_monitor_lockdown() {
8145         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8146         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8147         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8148         //
8149         // This scenario may happen in a watchtower setup, where watchtower process a block height
8150         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8151         // commitment at same time.
8152
8153         let chanmon_cfgs = create_chanmon_cfgs(2);
8154         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8155         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8156         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8157
8158         // Create some initial channel
8159         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8160         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8161
8162         // Rebalance the network to generate htlc in the two directions
8163         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8164
8165         // Route a HTLC from node 0 to node 1 (but don't settle)
8166         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8167
8168         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8169         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8170         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8171         let persister = test_utils::TestPersister::new();
8172         let watchtower = {
8173                 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
8174                 let mut w = test_utils::TestVecWriter(Vec::new());
8175                 monitor.write(&mut w).unwrap();
8176                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8177                                 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8178                 assert!(new_monitor == *monitor);
8179                 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);
8180                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8181                 watchtower
8182         };
8183         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8184         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8185         // transaction lock time requirements here.
8186         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (header, 0));
8187         watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8188
8189         // Try to update ChannelMonitor
8190         assert!(nodes[1].node.claim_funds(preimage));
8191         check_added_monitors!(nodes[1], 1);
8192         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8193         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8194         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8195         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8196                 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8197                         if let Err(_) =  watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8198                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8199                 } else { assert!(false); }
8200         } else { assert!(false); };
8201         // Our local monitor is in-sync and hasn't processed yet timeout
8202         check_added_monitors!(nodes[0], 1);
8203         let events = nodes[0].node.get_and_clear_pending_events();
8204         assert_eq!(events.len(), 1);
8205 }
8206
8207 #[test]
8208 fn test_concurrent_monitor_claim() {
8209         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8210         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8211         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8212         // state N+1 confirms. Alice claims output from state N+1.
8213
8214         let chanmon_cfgs = create_chanmon_cfgs(2);
8215         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8216         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8217         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8218
8219         // Create some initial channel
8220         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8221         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8222
8223         // Rebalance the network to generate htlc in the two directions
8224         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8225
8226         // Route a HTLC from node 0 to node 1 (but don't settle)
8227         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8228
8229         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8230         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8231         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8232         let persister = test_utils::TestPersister::new();
8233         let watchtower_alice = {
8234                 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
8235                 let mut w = test_utils::TestVecWriter(Vec::new());
8236                 monitor.write(&mut w).unwrap();
8237                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8238                                 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8239                 assert!(new_monitor == *monitor);
8240                 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);
8241                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8242                 watchtower
8243         };
8244         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8245         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8246         // transaction lock time requirements here.
8247         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (header, 0));
8248         watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8249
8250         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8251         {
8252                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8253                 assert_eq!(txn.len(), 2);
8254                 txn.clear();
8255         }
8256
8257         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8258         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8259         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8260         let persister = test_utils::TestPersister::new();
8261         let watchtower_bob = {
8262                 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
8263                 let mut w = test_utils::TestVecWriter(Vec::new());
8264                 monitor.write(&mut w).unwrap();
8265                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8266                                 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8267                 assert!(new_monitor == *monitor);
8268                 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);
8269                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8270                 watchtower
8271         };
8272         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8273         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8274
8275         // Route another payment to generate another update with still previous HTLC pending
8276         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 3000000);
8277         {
8278                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8279         }
8280         check_added_monitors!(nodes[1], 1);
8281
8282         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8283         assert_eq!(updates.update_add_htlcs.len(), 1);
8284         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8285         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8286                 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8287                         // Watchtower Alice should already have seen the block and reject the update
8288                         if let Err(_) =  watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8289                         if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8290                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8291                 } else { assert!(false); }
8292         } else { assert!(false); };
8293         // Our local monitor is in-sync and hasn't processed yet timeout
8294         check_added_monitors!(nodes[0], 1);
8295
8296         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8297         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8298         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8299
8300         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8301         let bob_state_y;
8302         {
8303                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8304                 assert_eq!(txn.len(), 2);
8305                 bob_state_y = txn[0].clone();
8306                 txn.clear();
8307         };
8308
8309         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8310         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8311         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);
8312         {
8313                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8314                 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8315                 // the onchain detection of the HTLC output
8316                 assert_eq!(htlc_txn.len(), 2);
8317                 check_spends!(htlc_txn[0], bob_state_y);
8318                 check_spends!(htlc_txn[1], bob_state_y);
8319         }
8320 }
8321
8322 #[test]
8323 fn test_pre_lockin_no_chan_closed_update() {
8324         // Test that if a peer closes a channel in response to a funding_created message we don't
8325         // generate a channel update (as the channel cannot appear on chain without a funding_signed
8326         // message).
8327         //
8328         // Doing so would imply a channel monitor update before the initial channel monitor
8329         // registration, violating our API guarantees.
8330         //
8331         // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8332         // then opening a second channel with the same funding output as the first (which is not
8333         // rejected because the first channel does not exist in the ChannelManager) and closing it
8334         // before receiving funding_signed.
8335         let chanmon_cfgs = create_chanmon_cfgs(2);
8336         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8337         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8338         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8339
8340         // Create an initial channel
8341         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8342         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8343         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8344         let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8345         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8346
8347         // Move the first channel through the funding flow...
8348         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8349
8350         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8351         check_added_monitors!(nodes[0], 0);
8352
8353         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8354         let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8355         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8356         assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8357         check_closed_event!(nodes[0], 2, ClosureReason::CounterpartyForceClosed { peer_msg: "Hi".to_string() }, true);
8358 }
8359
8360 #[test]
8361 fn test_htlc_no_detection() {
8362         // This test is a mutation to underscore the detection logic bug we had
8363         // before #653. HTLC value routed is above the remaining balance, thus
8364         // inverting HTLC and `to_remote` output. HTLC will come second and
8365         // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8366         // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8367         // outputs order detection for correct spending children filtring.
8368
8369         let chanmon_cfgs = create_chanmon_cfgs(2);
8370         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8371         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8372         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8373
8374         // Create some initial channels
8375         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8376
8377         send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8378         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8379         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8380         assert_eq!(local_txn[0].input.len(), 1);
8381         assert_eq!(local_txn[0].output.len(), 3);
8382         check_spends!(local_txn[0], chan_1.3);
8383
8384         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8385         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8386         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8387         // We deliberately connect the local tx twice as this should provoke a failure calling
8388         // this test before #653 fix.
8389         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);
8390         check_closed_broadcast!(nodes[0], true);
8391         check_added_monitors!(nodes[0], 1);
8392         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
8393         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
8394
8395         let htlc_timeout = {
8396                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8397                 assert_eq!(node_txn[1].input.len(), 1);
8398                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8399                 check_spends!(node_txn[1], local_txn[0]);
8400                 node_txn[1].clone()
8401         };
8402
8403         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8404         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8405         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8406         expect_payment_failed!(nodes[0], our_payment_hash, true);
8407 }
8408
8409 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8410         // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8411         // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8412         // Carol, Alice would be the upstream node, and Carol the downstream.)
8413         //
8414         // Steps of the test:
8415         // 1) Alice sends a HTLC to Carol through Bob.
8416         // 2) Carol doesn't settle the HTLC.
8417         // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8418         // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8419         // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8420         //    but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8421         // 5) Carol release the preimage to Bob off-chain.
8422         // 6) Bob claims the offered output on the broadcasted commitment.
8423         let chanmon_cfgs = create_chanmon_cfgs(3);
8424         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8425         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8426         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8427
8428         // Create some initial channels
8429         let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8430         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8431
8432         // Steps (1) and (2):
8433         // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8434         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8435
8436         // Check that Alice's commitment transaction now contains an output for this HTLC.
8437         let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8438         check_spends!(alice_txn[0], chan_ab.3);
8439         assert_eq!(alice_txn[0].output.len(), 2);
8440         check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8441         assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8442         assert_eq!(alice_txn.len(), 2);
8443
8444         // Steps (3) and (4):
8445         // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8446         // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8447         let mut force_closing_node = 0; // Alice force-closes
8448         if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8449         nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8450         check_closed_broadcast!(nodes[force_closing_node], true);
8451         check_added_monitors!(nodes[force_closing_node], 1);
8452         check_closed_event!(nodes[force_closing_node], 1, ClosureReason::HolderForceClosed);
8453         if go_onchain_before_fulfill {
8454                 let txn_to_broadcast = match broadcast_alice {
8455                         true => alice_txn.clone(),
8456                         false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8457                 };
8458                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8459                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8460                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8461                 if broadcast_alice {
8462                         check_closed_broadcast!(nodes[1], true);
8463                         check_added_monitors!(nodes[1], 1);
8464                         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
8465                 }
8466                 assert_eq!(bob_txn.len(), 1);
8467                 check_spends!(bob_txn[0], chan_ab.3);
8468         }
8469
8470         // Step (5):
8471         // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8472         // process of removing the HTLC from their commitment transactions.
8473         assert!(nodes[2].node.claim_funds(payment_preimage));
8474         check_added_monitors!(nodes[2], 1);
8475         let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8476         assert!(carol_updates.update_add_htlcs.is_empty());
8477         assert!(carol_updates.update_fail_htlcs.is_empty());
8478         assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8479         assert!(carol_updates.update_fee.is_none());
8480         assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8481
8482         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8483         expect_payment_forwarded!(nodes[1], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
8484         // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8485         if !go_onchain_before_fulfill && broadcast_alice {
8486                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8487                 assert_eq!(events.len(), 1);
8488                 match events[0] {
8489                         MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8490                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8491                         },
8492                         _ => panic!("Unexpected event"),
8493                 };
8494         }
8495         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8496         // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8497         // Carol<->Bob's updated commitment transaction info.
8498         check_added_monitors!(nodes[1], 2);
8499
8500         let events = nodes[1].node.get_and_clear_pending_msg_events();
8501         assert_eq!(events.len(), 2);
8502         let bob_revocation = match events[0] {
8503                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8504                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8505                         (*msg).clone()
8506                 },
8507                 _ => panic!("Unexpected event"),
8508         };
8509         let bob_updates = match events[1] {
8510                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8511                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8512                         (*updates).clone()
8513                 },
8514                 _ => panic!("Unexpected event"),
8515         };
8516
8517         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8518         check_added_monitors!(nodes[2], 1);
8519         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8520         check_added_monitors!(nodes[2], 1);
8521
8522         let events = nodes[2].node.get_and_clear_pending_msg_events();
8523         assert_eq!(events.len(), 1);
8524         let carol_revocation = match events[0] {
8525                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8526                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8527                         (*msg).clone()
8528                 },
8529                 _ => panic!("Unexpected event"),
8530         };
8531         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8532         check_added_monitors!(nodes[1], 1);
8533
8534         // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8535         // here's where we put said channel's commitment tx on-chain.
8536         let mut txn_to_broadcast = alice_txn.clone();
8537         if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8538         if !go_onchain_before_fulfill {
8539                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8540                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8541                 // If Bob was the one to force-close, he will have already passed these checks earlier.
8542                 if broadcast_alice {
8543                         check_closed_broadcast!(nodes[1], true);
8544                         check_added_monitors!(nodes[1], 1);
8545                         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
8546                 }
8547                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8548                 if broadcast_alice {
8549                         // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8550                         // new block being connected. The ChannelManager being notified triggers a monitor update,
8551                         // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8552                         // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8553                         // broadcasted.
8554                         assert_eq!(bob_txn.len(), 3);
8555                         check_spends!(bob_txn[1], chan_ab.3);
8556                 } else {
8557                         assert_eq!(bob_txn.len(), 2);
8558                         check_spends!(bob_txn[0], chan_ab.3);
8559                 }
8560         }
8561
8562         // Step (6):
8563         // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8564         // broadcasted commitment transaction.
8565         {
8566                 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8567                 if go_onchain_before_fulfill {
8568                         // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
8569                         assert_eq!(bob_txn.len(), 2);
8570                 }
8571                 let script_weight = match broadcast_alice {
8572                         true => OFFERED_HTLC_SCRIPT_WEIGHT,
8573                         false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8574                 };
8575                 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
8576                 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
8577                 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
8578                 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
8579                 if broadcast_alice && !go_onchain_before_fulfill {
8580                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
8581                         assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
8582                 } else {
8583                         check_spends!(bob_txn[1], txn_to_broadcast[0]);
8584                         assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
8585                 }
8586         }
8587 }
8588
8589 #[test]
8590 fn test_onchain_htlc_settlement_after_close() {
8591         do_test_onchain_htlc_settlement_after_close(true, true);
8592         do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
8593         do_test_onchain_htlc_settlement_after_close(true, false);
8594         do_test_onchain_htlc_settlement_after_close(false, false);
8595 }
8596
8597 #[test]
8598 fn test_duplicate_chan_id() {
8599         // Test that if a given peer tries to open a channel with the same channel_id as one that is
8600         // already open we reject it and keep the old channel.
8601         //
8602         // Previously, full_stack_target managed to figure out that if you tried to open two channels
8603         // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
8604         // the existing channel when we detect the duplicate new channel, screwing up our monitor
8605         // updating logic for the existing channel.
8606         let chanmon_cfgs = create_chanmon_cfgs(2);
8607         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8608         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8609         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8610
8611         // Create an initial channel
8612         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8613         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8614         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8615         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
8616
8617         // Try to create a second channel with the same temporary_channel_id as the first and check
8618         // that it is rejected.
8619         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8620         {
8621                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8622                 assert_eq!(events.len(), 1);
8623                 match events[0] {
8624                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8625                                 // Technically, at this point, nodes[1] would be justified in thinking both the
8626                                 // first (valid) and second (invalid) channels are closed, given they both have
8627                                 // the same non-temporary channel_id. However, currently we do not, so we just
8628                                 // move forward with it.
8629                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8630                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8631                         },
8632                         _ => panic!("Unexpected event"),
8633                 }
8634         }
8635
8636         // Move the first channel through the funding flow...
8637         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
8638
8639         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8640         check_added_monitors!(nodes[0], 0);
8641
8642         let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8643         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8644         {
8645                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
8646                 assert_eq!(added_monitors.len(), 1);
8647                 assert_eq!(added_monitors[0].0, funding_output);
8648                 added_monitors.clear();
8649         }
8650         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8651
8652         let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
8653         let channel_id = funding_outpoint.to_channel_id();
8654
8655         // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
8656         // temporary one).
8657
8658         // First try to open a second channel with a temporary channel id equal to the txid-based one.
8659         // Technically this is allowed by the spec, but we don't support it and there's little reason
8660         // to. Still, it shouldn't cause any other issues.
8661         open_chan_msg.temporary_channel_id = channel_id;
8662         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8663         {
8664                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8665                 assert_eq!(events.len(), 1);
8666                 match events[0] {
8667                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8668                                 // Technically, at this point, nodes[1] would be justified in thinking both
8669                                 // channels are closed, but currently we do not, so we just move forward with it.
8670                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8671                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8672                         },
8673                         _ => panic!("Unexpected event"),
8674                 }
8675         }
8676
8677         // Now try to create a second channel which has a duplicate funding output.
8678         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8679         let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8680         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
8681         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
8682         create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
8683
8684         let funding_created = {
8685                 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
8686                 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
8687                 let logger = test_utils::TestLogger::new();
8688                 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
8689         };
8690         check_added_monitors!(nodes[0], 0);
8691         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
8692         // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
8693         // still needs to be cleared here.
8694         check_added_monitors!(nodes[1], 1);
8695
8696         // ...still, nodes[1] will reject the duplicate channel.
8697         {
8698                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8699                 assert_eq!(events.len(), 1);
8700                 match events[0] {
8701                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8702                                 // Technically, at this point, nodes[1] would be justified in thinking both
8703                                 // channels are closed, but currently we do not, so we just move forward with it.
8704                                 assert_eq!(msg.channel_id, channel_id);
8705                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8706                         },
8707                         _ => panic!("Unexpected event"),
8708                 }
8709         }
8710
8711         // finally, finish creating the original channel and send a payment over it to make sure
8712         // everything is functional.
8713         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
8714         {
8715                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
8716                 assert_eq!(added_monitors.len(), 1);
8717                 assert_eq!(added_monitors[0].0, funding_output);
8718                 added_monitors.clear();
8719         }
8720
8721         let events_4 = nodes[0].node.get_and_clear_pending_events();
8722         assert_eq!(events_4.len(), 0);
8723         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
8724         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
8725
8726         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8727         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
8728         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
8729         send_payment(&nodes[0], &[&nodes[1]], 8000000);
8730 }
8731
8732 #[test]
8733 fn test_error_chans_closed() {
8734         // Test that we properly handle error messages, closing appropriate channels.
8735         //
8736         // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
8737         // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
8738         // we can test various edge cases around it to ensure we don't regress.
8739         let chanmon_cfgs = create_chanmon_cfgs(3);
8740         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8741         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8742         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8743
8744         // Create some initial channels
8745         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8746         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8747         let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8748
8749         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8750         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
8751         assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
8752
8753         // Closing a channel from a different peer has no effect
8754         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
8755         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8756
8757         // Closing one channel doesn't impact others
8758         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
8759         check_added_monitors!(nodes[0], 1);
8760         check_closed_broadcast!(nodes[0], false);
8761         check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyForceClosed { peer_msg: "ERR".to_string() });
8762         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
8763         assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
8764         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);
8765         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);
8766
8767         // A null channel ID should close all channels
8768         let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8769         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
8770         check_added_monitors!(nodes[0], 2);
8771         check_closed_event!(nodes[0], 2, ClosureReason::CounterpartyForceClosed { peer_msg: "ERR".to_string() });
8772         let events = nodes[0].node.get_and_clear_pending_msg_events();
8773         assert_eq!(events.len(), 2);
8774         match events[0] {
8775                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8776                         assert_eq!(msg.contents.flags & 2, 2);
8777                 },
8778                 _ => panic!("Unexpected event"),
8779         }
8780         match events[1] {
8781                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8782                         assert_eq!(msg.contents.flags & 2, 2);
8783                 },
8784                 _ => panic!("Unexpected event"),
8785         }
8786         // Note that at this point users of a standard PeerHandler will end up calling
8787         // peer_disconnected with no_connection_possible set to false, duplicating the
8788         // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
8789         // users with their own peer handling logic. We duplicate the call here, however.
8790         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8791         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8792
8793         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
8794         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8795         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8796 }
8797
8798 #[test]
8799 fn test_invalid_funding_tx() {
8800         // Test that we properly handle invalid funding transactions sent to us from a peer.
8801         //
8802         // Previously, all other major lightning implementations had failed to properly sanitize
8803         // funding transactions from their counterparties, leading to a multi-implementation critical
8804         // security vulnerability (though we always sanitized properly, we've previously had
8805         // un-released crashes in the sanitization process).
8806         let chanmon_cfgs = create_chanmon_cfgs(2);
8807         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8808         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8809         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8810
8811         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
8812         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
8813         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
8814
8815         let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
8816         for output in tx.output.iter_mut() {
8817                 // Make the confirmed funding transaction have a bogus script_pubkey
8818                 output.script_pubkey = bitcoin::Script::new();
8819         }
8820
8821         nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
8822         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()));
8823         check_added_monitors!(nodes[1], 1);
8824
8825         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()));
8826         check_added_monitors!(nodes[0], 1);
8827
8828         let events_1 = nodes[0].node.get_and_clear_pending_events();
8829         assert_eq!(events_1.len(), 0);
8830
8831         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
8832         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
8833         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
8834
8835         confirm_transaction_at(&nodes[1], &tx, 1);
8836         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
8837         check_added_monitors!(nodes[1], 1);
8838         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
8839         assert_eq!(events_2.len(), 1);
8840         if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
8841                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8842                 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
8843                         assert_eq!(msg.data, "funding tx had wrong script/value or output index");
8844                 } else { panic!(); }
8845         } else { panic!(); }
8846         assert_eq!(nodes[1].node.list_channels().len(), 0);
8847 }
8848
8849 fn do_test_tx_confirmed_skipping_blocks_immediate_broadcast(test_height_before_timelock: bool) {
8850         // In the first version of the chain::Confirm interface, after a refactor was made to not
8851         // broadcast CSV-locked transactions until their CSV lock is up, we wouldn't reliably broadcast
8852         // transactions after a `transactions_confirmed` call. Specifically, if the chain, provided via
8853         // `best_block_updated` is at height N, and a transaction output which we wish to spend at
8854         // height N-1 (due to a CSV to height N-1) is provided at height N, we will not broadcast the
8855         // spending transaction until height N+1 (or greater). This was due to the way
8856         // `ChannelMonitor::transactions_confirmed` worked, only checking if we should broadcast a
8857         // spending transaction at the height the input transaction was confirmed at, not whether we
8858         // should broadcast a spending transaction at the current height.
8859         // A second, similar, issue involved failing HTLCs backwards - because we only provided the
8860         // height at which transactions were confirmed to `OnchainTx::update_claims_view`, it wasn't
8861         // aware that the anti-reorg-delay had, in fact, already expired, waiting to fail-backwards
8862         // until we learned about an additional block.
8863         //
8864         // As an additional check, if `test_height_before_timelock` is set, we instead test that we
8865         // aren't broadcasting transactions too early (ie not broadcasting them at all).
8866         let chanmon_cfgs = create_chanmon_cfgs(3);
8867         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8868         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8869         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8870         *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
8871
8872         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8873         let (chan_announce, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
8874         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
8875         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
8876         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
8877
8878         nodes[1].node.force_close_channel(&channel_id).unwrap();
8879         check_closed_broadcast!(nodes[1], true);
8880         check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
8881         check_added_monitors!(nodes[1], 1);
8882         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
8883         assert_eq!(node_txn.len(), 1);
8884
8885         let conf_height = nodes[1].best_block_info().1;
8886         if !test_height_before_timelock {
8887                 connect_blocks(&nodes[1], 24 * 6);
8888         }
8889         nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
8890                 &nodes[1].get_block_header(conf_height), &[(0, &node_txn[0])], conf_height);
8891         if test_height_before_timelock {
8892                 // If we confirmed the close transaction, but timelocks have not yet expired, we should not
8893                 // generate any events or broadcast any transactions
8894                 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8895                 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
8896         } else {
8897                 // We should broadcast an HTLC transaction spending our funding transaction first
8898                 let spending_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
8899                 assert_eq!(spending_txn.len(), 2);
8900                 assert_eq!(spending_txn[0], node_txn[0]);
8901                 check_spends!(spending_txn[1], node_txn[0]);
8902                 // We should also generate a SpendableOutputs event with the to_self output (as its
8903                 // timelock is up).
8904                 let descriptor_spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
8905                 assert_eq!(descriptor_spend_txn.len(), 1);
8906
8907                 // If we also discover that the HTLC-Timeout transaction was confirmed some time ago, we
8908                 // should immediately fail-backwards the HTLC to the previous hop, without waiting for an
8909                 // additional block built on top of the current chain.
8910                 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
8911                         &nodes[1].get_block_header(conf_height + 1), &[(0, &spending_txn[1])], conf_height + 1);
8912                 expect_pending_htlcs_forwardable!(nodes[1]);
8913                 check_added_monitors!(nodes[1], 1);
8914
8915                 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8916                 assert!(updates.update_add_htlcs.is_empty());
8917                 assert!(updates.update_fulfill_htlcs.is_empty());
8918                 assert_eq!(updates.update_fail_htlcs.len(), 1);
8919                 assert!(updates.update_fail_malformed_htlcs.is_empty());
8920                 assert!(updates.update_fee.is_none());
8921                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
8922                 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
8923                 expect_payment_failed_with_update!(nodes[0], payment_hash, false, chan_announce.contents.short_channel_id, true);
8924         }
8925 }
8926
8927 #[test]
8928 fn test_tx_confirmed_skipping_blocks_immediate_broadcast() {
8929         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(false);
8930         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(true);
8931 }
8932
8933 #[test]
8934 fn test_forwardable_regen() {
8935         // Tests that if we reload a ChannelManager while forwards are pending we will regenerate the
8936         // PendingHTLCsForwardable event automatically, ensuring we don't forget to forward/receive
8937         // HTLCs.
8938         // We test it for both payment receipt and payment forwarding.
8939
8940         let chanmon_cfgs = create_chanmon_cfgs(3);
8941         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8942         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8943         let persister: test_utils::TestPersister;
8944         let new_chain_monitor: test_utils::TestChainMonitor;
8945         let nodes_1_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
8946         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8947         let chan_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8948         let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known()).2;
8949
8950         // First send a payment to nodes[1]
8951         let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
8952         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8953         check_added_monitors!(nodes[0], 1);
8954
8955         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8956         assert_eq!(events.len(), 1);
8957         let payment_event = SendEvent::from_event(events.pop().unwrap());
8958         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8959         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8960
8961         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
8962
8963         // Next send a payment which is forwarded by nodes[1]
8964         let (route_2, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[2], 200_000);
8965         nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
8966         check_added_monitors!(nodes[0], 1);
8967
8968         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8969         assert_eq!(events.len(), 1);
8970         let payment_event = SendEvent::from_event(events.pop().unwrap());
8971         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8972         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8973
8974         // There is already a PendingHTLCsForwardable event "pending" so another one will not be
8975         // generated
8976         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
8977
8978         // Now restart nodes[1] and make sure it regenerates a single PendingHTLCsForwardable
8979         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
8980         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
8981
8982         let nodes_1_serialized = nodes[1].node.encode();
8983         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
8984         let mut chan_1_monitor_serialized = test_utils::TestVecWriter(Vec::new());
8985         get_monitor!(nodes[1], chan_id_1).write(&mut chan_0_monitor_serialized).unwrap();
8986         get_monitor!(nodes[1], chan_id_2).write(&mut chan_1_monitor_serialized).unwrap();
8987
8988         persister = test_utils::TestPersister::new();
8989         let keys_manager = &chanmon_cfgs[1].keys_manager;
8990         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[1].chain_source), nodes[1].tx_broadcaster.clone(), nodes[1].logger, node_cfgs[1].fee_estimator, &persister, keys_manager);
8991         nodes[1].chain_monitor = &new_chain_monitor;
8992
8993         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
8994         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
8995                 &mut chan_0_monitor_read, keys_manager).unwrap();
8996         assert!(chan_0_monitor_read.is_empty());
8997         let mut chan_1_monitor_read = &chan_1_monitor_serialized.0[..];
8998         let (_, mut chan_1_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
8999                 &mut chan_1_monitor_read, keys_manager).unwrap();
9000         assert!(chan_1_monitor_read.is_empty());
9001
9002         let mut nodes_1_read = &nodes_1_serialized[..];
9003         let (_, nodes_1_deserialized_tmp) = {
9004                 let mut channel_monitors = HashMap::new();
9005                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
9006                 channel_monitors.insert(chan_1_monitor.get_funding_txo().0, &mut chan_1_monitor);
9007                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_1_read, ChannelManagerReadArgs {
9008                         default_config: UserConfig::default(),
9009                         keys_manager,
9010                         fee_estimator: node_cfgs[1].fee_estimator,
9011                         chain_monitor: nodes[1].chain_monitor,
9012                         tx_broadcaster: nodes[1].tx_broadcaster.clone(),
9013                         logger: nodes[1].logger,
9014                         channel_monitors,
9015                 }).unwrap()
9016         };
9017         nodes_1_deserialized = nodes_1_deserialized_tmp;
9018         assert!(nodes_1_read.is_empty());
9019
9020         assert!(nodes[1].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
9021         assert!(nodes[1].chain_monitor.watch_channel(chan_1_monitor.get_funding_txo().0, chan_1_monitor).is_ok());
9022         nodes[1].node = &nodes_1_deserialized;
9023         check_added_monitors!(nodes[1], 2);
9024
9025         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
9026         // Note that nodes[1] and nodes[2] resend their funding_locked here since they haven't updated
9027         // the commitment state.
9028         reconnect_nodes(&nodes[1], &nodes[2], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
9029
9030         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
9031
9032         expect_pending_htlcs_forwardable!(nodes[1]);
9033         expect_payment_received!(nodes[1], payment_hash, payment_secret, 100_000);
9034         check_added_monitors!(nodes[1], 1);
9035
9036         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
9037         assert_eq!(events.len(), 1);
9038         let payment_event = SendEvent::from_event(events.pop().unwrap());
9039         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
9040         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false);
9041         expect_pending_htlcs_forwardable!(nodes[2]);
9042         expect_payment_received!(nodes[2], payment_hash_2, payment_secret_2, 200_000);
9043
9044         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
9045         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_2);
9046 }
9047
9048 #[test]
9049 fn test_keysend_payments_to_public_node() {
9050         let chanmon_cfgs = create_chanmon_cfgs(2);
9051         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9052         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9053         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9054
9055         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9056         let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
9057         let payer_pubkey = nodes[0].node.get_our_node_id();
9058         let payee_pubkey = nodes[1].node.get_our_node_id();
9059         let params = RouteParameters {
9060                 payee: Payee::for_keysend(payee_pubkey),
9061                 final_value_msat: 10000,
9062                 final_cltv_expiry_delta: 40,
9063         };
9064         let scorer = Scorer::with_fixed_penalty(0);
9065         let route = find_route(&payer_pubkey, &params, &network_graph, None, nodes[0].logger, &scorer).unwrap();
9066
9067         let test_preimage = PaymentPreimage([42; 32]);
9068         let (payment_hash, _) = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage)).unwrap();
9069         check_added_monitors!(nodes[0], 1);
9070         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9071         assert_eq!(events.len(), 1);
9072         let event = events.pop().unwrap();
9073         let path = vec![&nodes[1]];
9074         pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9075         claim_payment(&nodes[0], &path, test_preimage);
9076 }
9077
9078 #[test]
9079 fn test_keysend_payments_to_private_node() {
9080         let chanmon_cfgs = create_chanmon_cfgs(2);
9081         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9082         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9083         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9084
9085         let payer_pubkey = nodes[0].node.get_our_node_id();
9086         let payee_pubkey = nodes[1].node.get_our_node_id();
9087         nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known() });
9088         nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known() });
9089
9090         let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
9091         let params = RouteParameters {
9092                 payee: Payee::for_keysend(payee_pubkey),
9093                 final_value_msat: 10000,
9094                 final_cltv_expiry_delta: 40,
9095         };
9096         let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
9097         let first_hops = nodes[0].node.list_usable_channels();
9098         let scorer = Scorer::with_fixed_penalty(0);
9099         let route = find_route(
9100                 &payer_pubkey, &params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
9101                 nodes[0].logger, &scorer
9102         ).unwrap();
9103
9104         let test_preimage = PaymentPreimage([42; 32]);
9105         let (payment_hash, _) = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage)).unwrap();
9106         check_added_monitors!(nodes[0], 1);
9107         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9108         assert_eq!(events.len(), 1);
9109         let event = events.pop().unwrap();
9110         let path = vec![&nodes[1]];
9111         pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9112         claim_payment(&nodes[0], &path, test_preimage);
9113 }