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

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   7 // You may not use this file except in accordance with one or both of these
   8 // licenses.
   9
  10 //! Tests that test standing up a network of ChannelManagers, creating channels, sending
  11 //! payments/messages between them, and often checking the resulting ChannelMonitors are able to
  12 //! claim outputs on-chain.
  13
  14 use chain;
  15 use chain::{Confirm, Listen, Watch};
  16 use chain::channelmonitor;
  17 use chain::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
  18 use chain::transaction::OutPoint;
  19 use chain::keysinterface::BaseSign;
  20 use ln::{PaymentPreimage, PaymentSecret, PaymentHash};
  21 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
  22 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, MppId, RAACommitmentOrder, PaymentSendFailure, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA};
  23 use ln::channel::{Channel, ChannelError};
  24 use ln::{chan_utils, onion_utils};
  25 use ln::chan_utils::HTLC_SUCCESS_TX_WEIGHT;
  26 use routing::router::{Route, RouteHop, RouteHint, RouteHintHop, get_route, get_keysend_route};
  27 use routing::network_graph::{NetworkUpdate, RoutingFees};
  28 use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
  29 use ln::msgs;
  30 use ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
  31 use util::enforcing_trait_impls::EnforcingSigner;
  32 use util::{byte_utils, test_utils};
  33 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
  34 use util::errors::APIError;
  35 use util::ser::{Writeable, ReadableArgs};
  36 use util::config::UserConfig;
  37
  38 use bitcoin::hash_types::{Txid, BlockHash};
  39 use bitcoin::blockdata::block::{Block, BlockHeader};
  40 use bitcoin::blockdata::script::Builder;
  41 use bitcoin::blockdata::opcodes;
  42 use bitcoin::blockdata::constants::genesis_block;
  43 use bitcoin::network::constants::Network;
  44
  45 use bitcoin::hashes::sha256::Hash as Sha256;
  46 use bitcoin::hashes::Hash;
  47
  48 use bitcoin::secp256k1::Secp256k1;
  49 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
  50
  51 use regex;
  52
  53 use io;
  54 use prelude::*;
  55 use alloc::collections::BTreeSet;
  56 use core::default::Default;
  57 use sync::{Arc, Mutex};
  58
  59 use ln::functional_test_utils::*;
  60 use ln::chan_utils::CommitmentTransaction;
  61
  62 #[test]
  63 fn test_insane_channel_opens() {
  64         // Stand up a network of 2 nodes
  65         let chanmon_cfgs = create_chanmon_cfgs(2);
  66         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  67         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  68         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  69
  70         // Instantiate channel parameters where we push the maximum msats given our
  71         // funding satoshis
  72         let channel_value_sat = 31337; // same as funding satoshis
  73         let channel_reserve_satoshis = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value_sat);
  74         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  75
  76         // Have node0 initiate a channel to node1 with aforementioned parameters
  77         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
  78
  79         // Extract the channel open message from node0 to node1
  80         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  81
  82         // Test helper that asserts we get the correct error string given a mutator
  83         // that supposedly makes the channel open message insane
  84         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  85                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
  86                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  87                 assert_eq!(msg_events.len(), 1);
  88                 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
  89                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  90                         match action {
  91                                 &ErrorAction::SendErrorMessage { .. } => {
  92                                         nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
  93                                 },
  94                                 _ => panic!("unexpected event!"),
  95                         }
  96                 } else { assert!(false); }
  97         };
  98
  99         use ln::channel::MAX_FUNDING_SATOSHIS;
 100         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
 101
 102         // Test all mutations that would make the channel open message insane
 103         insane_open_helper(format!("Funding must be smaller than {}. It was {}", MAX_FUNDING_SATOSHIS, MAX_FUNDING_SATOSHIS).as_str(), |mut msg| { msg.funding_satoshis = MAX_FUNDING_SATOSHIS; msg });
 104
 105         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
 106
 107         insane_open_helper(r"push_msat \d+ was larger than funding value \d+", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
 108
 109         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
 110
 111         insane_open_helper(r"Bogus; channel reserve \(\d+\) is less than dust limit \(\d+\)", |mut msg| { msg.dust_limit_satoshis = msg.channel_reserve_satoshis + 1; msg });
 112
 113         insane_open_helper(r"Minimum htlc value \(\d+\) was larger than full channel value \(\d+\)", |mut msg| { msg.htlc_minimum_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000; msg });
 114
 115         insane_open_helper("They wanted our payments to be delayed by a needlessly long period", |mut msg| { msg.to_self_delay = MAX_LOCAL_BREAKDOWN_TIMEOUT + 1; msg });
 116
 117         insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 118
 119         insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 120 }
 121
 122 #[test]
 123 fn test_async_inbound_update_fee() {
 124         let chanmon_cfgs = create_chanmon_cfgs(2);
 125         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 126         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 127         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 128         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 129         let logger = test_utils::TestLogger::new();
 130
 131         // balancing
 132         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 133
 134         // A                                        B
 135         // update_fee                            ->
 136         // send (1) commitment_signed            -.
 137         //                                       <- update_add_htlc/commitment_signed
 138         // send (2) RAA (awaiting remote revoke) -.
 139         // (1) commitment_signed is delivered    ->
 140         //                                       .- send (3) RAA (awaiting remote revoke)
 141         // (2) RAA is delivered                  ->
 142         //                                       .- send (4) commitment_signed
 143         //                                       <- (3) RAA is delivered
 144         // send (5) commitment_signed            -.
 145         //                                       <- (4) commitment_signed is delivered
 146         // send (6) RAA                          -.
 147         // (5) commitment_signed is delivered    ->
 148         //                                       <- RAA
 149         // (6) RAA is delivered                  ->
 150
 151         // First nodes[0] generates an update_fee
 152         {
 153                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 154                 *feerate_lock += 20;
 155         }
 156         nodes[0].node.timer_tick_occurred();
 157         check_added_monitors!(nodes[0], 1);
 158
 159         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 160         assert_eq!(events_0.len(), 1);
 161         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 162                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 163                         (update_fee.as_ref(), commitment_signed)
 164                 },
 165                 _ => panic!("Unexpected event"),
 166         };
 167
 168         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 169
 170         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 171         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 172         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 173         nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &Some(our_payment_secret)).unwrap();
 174         check_added_monitors!(nodes[1], 1);
 175
 176         let payment_event = {
 177                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 178                 assert_eq!(events_1.len(), 1);
 179                 SendEvent::from_event(events_1.remove(0))
 180         };
 181         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 182         assert_eq!(payment_event.msgs.len(), 1);
 183
 184         // ...now when the messages get delivered everyone should be happy
 185         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 186         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 187         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 188         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 189         check_added_monitors!(nodes[0], 1);
 190
 191         // deliver(1), generate (3):
 192         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 193         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 194         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 195         check_added_monitors!(nodes[1], 1);
 196
 197         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 198         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 199         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 200         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 201         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 202         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 203         assert!(bs_update.update_fee.is_none()); // (4)
 204         check_added_monitors!(nodes[1], 1);
 205
 206         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 207         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 208         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 209         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 210         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 211         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 212         assert!(as_update.update_fee.is_none()); // (5)
 213         check_added_monitors!(nodes[0], 1);
 214
 215         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 216         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 217         // only (6) so get_event_msg's assert(len == 1) passes
 218         check_added_monitors!(nodes[0], 1);
 219
 220         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 221         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 222         check_added_monitors!(nodes[1], 1);
 223
 224         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 225         check_added_monitors!(nodes[0], 1);
 226
 227         let events_2 = nodes[0].node.get_and_clear_pending_events();
 228         assert_eq!(events_2.len(), 1);
 229         match events_2[0] {
 230                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 231                 _ => panic!("Unexpected event"),
 232         }
 233
 234         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 235         check_added_monitors!(nodes[1], 1);
 236 }
 237
 238 #[test]
 239 fn test_update_fee_unordered_raa() {
 240         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 241         // crash in an earlier version of the update_fee patch)
 242         let chanmon_cfgs = create_chanmon_cfgs(2);
 243         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 244         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 245         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 246         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 247         let logger = test_utils::TestLogger::new();
 248
 249         // balancing
 250         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 251
 252         // First nodes[0] generates an update_fee
 253         {
 254                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 255                 *feerate_lock += 20;
 256         }
 257         nodes[0].node.timer_tick_occurred();
 258         check_added_monitors!(nodes[0], 1);
 259
 260         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 261         assert_eq!(events_0.len(), 1);
 262         let update_msg = match events_0[0] { // (1)
 263                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 264                         update_fee.as_ref()
 265                 },
 266                 _ => panic!("Unexpected event"),
 267         };
 268
 269         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 270
 271         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 272         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 273         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 274         nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &Some(our_payment_secret)).unwrap();
 275         check_added_monitors!(nodes[1], 1);
 276
 277         let payment_event = {
 278                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 279                 assert_eq!(events_1.len(), 1);
 280                 SendEvent::from_event(events_1.remove(0))
 281         };
 282         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 283         assert_eq!(payment_event.msgs.len(), 1);
 284
 285         // ...now when the messages get delivered everyone should be happy
 286         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 287         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 288         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 289         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 290         check_added_monitors!(nodes[0], 1);
 291
 292         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 293         check_added_monitors!(nodes[1], 1);
 294
 295         // We can't continue, sadly, because our (1) now has a bogus signature
 296 }
 297
 298 #[test]
 299 fn test_multi_flight_update_fee() {
 300         let chanmon_cfgs = create_chanmon_cfgs(2);
 301         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 302         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 303         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 304         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 305
 306         // A                                        B
 307         // update_fee/commitment_signed          ->
 308         //                                       .- send (1) RAA and (2) commitment_signed
 309         // update_fee (never committed)          ->
 310         // (3) update_fee                        ->
 311         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 312         // don't track which updates correspond to which revoke_and_ack responses so we're in
 313         // AwaitingRAA mode and will not generate the update_fee yet.
 314         //                                       <- (1) RAA delivered
 315         // (3) is generated and send (4) CS      -.
 316         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 317         // know the per_commitment_point to use for it.
 318         //                                       <- (2) commitment_signed delivered
 319         // revoke_and_ack                        ->
 320         //                                          B should send no response here
 321         // (4) commitment_signed delivered       ->
 322         //                                       <- RAA/commitment_signed delivered
 323         // revoke_and_ack                        ->
 324
 325         // First nodes[0] generates an update_fee
 326         let initial_feerate;
 327         {
 328                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 329                 initial_feerate = *feerate_lock;
 330                 *feerate_lock = initial_feerate + 20;
 331         }
 332         nodes[0].node.timer_tick_occurred();
 333         check_added_monitors!(nodes[0], 1);
 334
 335         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 336         assert_eq!(events_0.len(), 1);
 337         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 338                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 339                         (update_fee.as_ref().unwrap(), commitment_signed)
 340                 },
 341                 _ => panic!("Unexpected event"),
 342         };
 343
 344         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 345         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 346         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 347         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 348         check_added_monitors!(nodes[1], 1);
 349
 350         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 351         // transaction:
 352         {
 353                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 354                 *feerate_lock = initial_feerate + 40;
 355         }
 356         nodes[0].node.timer_tick_occurred();
 357         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 358         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 359
 360         // Create the (3) update_fee message that nodes[0] will generate before it does...
 361         let mut update_msg_2 = msgs::UpdateFee {
 362                 channel_id: update_msg_1.channel_id.clone(),
 363                 feerate_per_kw: (initial_feerate + 30) as u32,
 364         };
 365
 366         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 367
 368         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 369         // Deliver (3)
 370         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 371
 372         // Deliver (1), generating (3) and (4)
 373         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 374         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 375         check_added_monitors!(nodes[0], 1);
 376         assert!(as_second_update.update_add_htlcs.is_empty());
 377         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 378         assert!(as_second_update.update_fail_htlcs.is_empty());
 379         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 380         // Check that the update_fee newly generated matches what we delivered:
 381         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 382         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 383
 384         // Deliver (2) commitment_signed
 385         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 386         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 387         check_added_monitors!(nodes[0], 1);
 388         // No commitment_signed so get_event_msg's assert(len == 1) passes
 389
 390         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 391         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 392         check_added_monitors!(nodes[1], 1);
 393
 394         // Delever (4)
 395         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 396         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 397         check_added_monitors!(nodes[1], 1);
 398
 399         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 400         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 401         check_added_monitors!(nodes[0], 1);
 402
 403         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 404         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 405         // No commitment_signed so get_event_msg's assert(len == 1) passes
 406         check_added_monitors!(nodes[0], 1);
 407
 408         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 409         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 410         check_added_monitors!(nodes[1], 1);
 411 }
 412
 413 fn do_test_1_conf_open(connect_style: ConnectStyle) {
 414         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 415         // tests that we properly send one in that case.
 416         let mut alice_config = UserConfig::default();
 417         alice_config.own_channel_config.minimum_depth = 1;
 418         alice_config.channel_options.announced_channel = true;
 419         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 420         let mut bob_config = UserConfig::default();
 421         bob_config.own_channel_config.minimum_depth = 1;
 422         bob_config.channel_options.announced_channel = true;
 423         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 424         let chanmon_cfgs = create_chanmon_cfgs(2);
 425         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 426         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 427         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 428         *nodes[0].connect_style.borrow_mut() = connect_style;
 429
 430         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
 431         mine_transaction(&nodes[1], &tx);
 432         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[0].node.get_our_node_id()));
 433
 434         mine_transaction(&nodes[0], &tx);
 435         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 436         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 437
 438         for node in nodes {
 439                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
 440                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
 441                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
 442         }
 443 }
 444 #[test]
 445 fn test_1_conf_open() {
 446         do_test_1_conf_open(ConnectStyle::BestBlockFirst);
 447         do_test_1_conf_open(ConnectStyle::TransactionsFirst);
 448         do_test_1_conf_open(ConnectStyle::FullBlockViaListen);
 449 }
 450
 451 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 452         // Previously, we had issues deserializing channels when we hadn't connected the first block
 453         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 454         // serialization round-trips and simply do steps towards opening a channel and then drop the
 455         // Node objects.
 456
 457         let chanmon_cfgs = create_chanmon_cfgs(2);
 458         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 459         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 460         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 461
 462         if steps & 0b1000_0000 != 0{
 463                 let block = Block {
 464                         header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 465                         txdata: vec![],
 466                 };
 467                 connect_block(&nodes[0], &block);
 468                 connect_block(&nodes[1], &block);
 469         }
 470
 471         if steps & 0x0f == 0 { return; }
 472         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 473         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 474
 475         if steps & 0x0f == 1 { return; }
 476         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
 477         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 478
 479         if steps & 0x0f == 2 { return; }
 480         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
 481
 482         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 483
 484         if steps & 0x0f == 3 { return; }
 485         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
 486         check_added_monitors!(nodes[0], 0);
 487         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 488
 489         if steps & 0x0f == 4 { return; }
 490         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 491         {
 492                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 493                 assert_eq!(added_monitors.len(), 1);
 494                 assert_eq!(added_monitors[0].0, funding_output);
 495                 added_monitors.clear();
 496         }
 497         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 498
 499         if steps & 0x0f == 5 { return; }
 500         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 501         {
 502                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 503                 assert_eq!(added_monitors.len(), 1);
 504                 assert_eq!(added_monitors[0].0, funding_output);
 505                 added_monitors.clear();
 506         }
 507
 508         let events_4 = nodes[0].node.get_and_clear_pending_events();
 509         assert_eq!(events_4.len(), 0);
 510
 511         if steps & 0x0f == 6 { return; }
 512         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
 513
 514         if steps & 0x0f == 7 { return; }
 515         confirm_transaction_at(&nodes[0], &tx, 2);
 516         connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
 517         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 518 }
 519
 520 #[test]
 521 fn test_sanity_on_in_flight_opens() {
 522         do_test_sanity_on_in_flight_opens(0);
 523         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 524         do_test_sanity_on_in_flight_opens(1);
 525         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 526         do_test_sanity_on_in_flight_opens(2);
 527         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 528         do_test_sanity_on_in_flight_opens(3);
 529         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 530         do_test_sanity_on_in_flight_opens(4);
 531         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 532         do_test_sanity_on_in_flight_opens(5);
 533         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 534         do_test_sanity_on_in_flight_opens(6);
 535         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 536         do_test_sanity_on_in_flight_opens(7);
 537         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 538         do_test_sanity_on_in_flight_opens(8);
 539         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 540 }
 541
 542 #[test]
 543 fn test_update_fee_vanilla() {
 544         let chanmon_cfgs = create_chanmon_cfgs(2);
 545         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 546         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 547         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 548         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 549
 550         {
 551                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 552                 *feerate_lock += 25;
 553         }
 554         nodes[0].node.timer_tick_occurred();
 555         check_added_monitors!(nodes[0], 1);
 556
 557         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 558         assert_eq!(events_0.len(), 1);
 559         let (update_msg, commitment_signed) = match events_0[0] {
 560                         MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
 561                         (update_fee.as_ref(), commitment_signed)
 562                 },
 563                 _ => panic!("Unexpected event"),
 564         };
 565         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 566
 567         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 568         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 569         check_added_monitors!(nodes[1], 1);
 570
 571         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 572         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 573         check_added_monitors!(nodes[0], 1);
 574
 575         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 576         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 577         // No commitment_signed so get_event_msg's assert(len == 1) passes
 578         check_added_monitors!(nodes[0], 1);
 579
 580         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 581         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 582         check_added_monitors!(nodes[1], 1);
 583 }
 584
 585 #[test]
 586 fn test_update_fee_that_funder_cannot_afford() {
 587         let chanmon_cfgs = create_chanmon_cfgs(2);
 588         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 589         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 590         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 591         let channel_value = 1888;
 592         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
 593         let channel_id = chan.2;
 594
 595         let feerate = 260;
 596         {
 597                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 598                 *feerate_lock = feerate;
 599         }
 600         nodes[0].node.timer_tick_occurred();
 601         check_added_monitors!(nodes[0], 1);
 602         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 603
 604         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 605
 606         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 607
 608         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 609         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 610         {
 611                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 612
 613                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 614                 let num_htlcs = commitment_tx.output.len() - 2;
 615                 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 616                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 617                 actual_fee = channel_value - actual_fee;
 618                 assert_eq!(total_fee, actual_fee);
 619         }
 620
 621         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 622         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 623         {
 624                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 625                 *feerate_lock = feerate + 2;
 626         }
 627         nodes[0].node.timer_tick_occurred();
 628         check_added_monitors!(nodes[0], 1);
 629
 630         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 631
 632         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 633
 634         //While producing the commitment_signed response after handling a received update_fee request the
 635         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 636         //Should produce and error.
 637         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 638         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 639         check_added_monitors!(nodes[1], 1);
 640         check_closed_broadcast!(nodes[1], true);
 641 }
 642
 643 #[test]
 644 fn test_update_fee_with_fundee_update_add_htlc() {
 645         let chanmon_cfgs = create_chanmon_cfgs(2);
 646         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 647         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 648         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 649         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 650         let logger = test_utils::TestLogger::new();
 651
 652         // balancing
 653         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 654
 655         {
 656                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 657                 *feerate_lock += 20;
 658         }
 659         nodes[0].node.timer_tick_occurred();
 660         check_added_monitors!(nodes[0], 1);
 661
 662         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 663         assert_eq!(events_0.len(), 1);
 664         let (update_msg, commitment_signed) = match events_0[0] {
 665                         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 } } => {
 666                         (update_fee.as_ref(), commitment_signed)
 667                 },
 668                 _ => panic!("Unexpected event"),
 669         };
 670         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 671         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 672         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 673         check_added_monitors!(nodes[1], 1);
 674
 675         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 676         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 677         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 800000, TEST_FINAL_CLTV, &logger).unwrap();
 678
 679         // nothing happens since node[1] is in AwaitingRemoteRevoke
 680         nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
 681         {
 682                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 683                 assert_eq!(added_monitors.len(), 0);
 684                 added_monitors.clear();
 685         }
 686         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 687         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 688         // node[1] has nothing to do
 689
 690         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 691         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 692         check_added_monitors!(nodes[0], 1);
 693
 694         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 695         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 696         // No commitment_signed so get_event_msg's assert(len == 1) passes
 697         check_added_monitors!(nodes[0], 1);
 698         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 699         check_added_monitors!(nodes[1], 1);
 700         // AwaitingRemoteRevoke ends here
 701
 702         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 703         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 704         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 705         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 706         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 707         assert_eq!(commitment_update.update_fee.is_none(), true);
 708
 709         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 710         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 711         check_added_monitors!(nodes[0], 1);
 712         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 713
 714         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 715         check_added_monitors!(nodes[1], 1);
 716         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 717
 718         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 719         check_added_monitors!(nodes[1], 1);
 720         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 721         // No commitment_signed so get_event_msg's assert(len == 1) passes
 722
 723         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 724         check_added_monitors!(nodes[0], 1);
 725         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 726
 727         expect_pending_htlcs_forwardable!(nodes[0]);
 728
 729         let events = nodes[0].node.get_and_clear_pending_events();
 730         assert_eq!(events.len(), 1);
 731         match events[0] {
 732                 Event::PaymentReceived { .. } => { },
 733                 _ => panic!("Unexpected event"),
 734         };
 735
 736         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
 737
 738         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
 739         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
 740         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 741 }
 742
 743 #[test]
 744 fn test_update_fee() {
 745         let chanmon_cfgs = create_chanmon_cfgs(2);
 746         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 747         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 748         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 749         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 750         let channel_id = chan.2;
 751
 752         // A                                        B
 753         // (1) update_fee/commitment_signed      ->
 754         //                                       <- (2) revoke_and_ack
 755         //                                       .- send (3) commitment_signed
 756         // (4) update_fee/commitment_signed      ->
 757         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 758         //                                       <- (3) commitment_signed delivered
 759         // send (6) revoke_and_ack               -.
 760         //                                       <- (5) deliver revoke_and_ack
 761         // (6) deliver revoke_and_ack            ->
 762         //                                       .- send (7) commitment_signed in response to (4)
 763         //                                       <- (7) deliver commitment_signed
 764         // revoke_and_ack                        ->
 765
 766         // Create and deliver (1)...
 767         let feerate;
 768         {
 769                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 770                 feerate = *feerate_lock;
 771                 *feerate_lock = feerate + 20;
 772         }
 773         nodes[0].node.timer_tick_occurred();
 774         check_added_monitors!(nodes[0], 1);
 775
 776         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 777         assert_eq!(events_0.len(), 1);
 778         let (update_msg, commitment_signed) = match events_0[0] {
 779                         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 } } => {
 780                         (update_fee.as_ref(), commitment_signed)
 781                 },
 782                 _ => panic!("Unexpected event"),
 783         };
 784         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 785
 786         // Generate (2) and (3):
 787         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 788         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 789         check_added_monitors!(nodes[1], 1);
 790
 791         // Deliver (2):
 792         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 793         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 794         check_added_monitors!(nodes[0], 1);
 795
 796         // Create and deliver (4)...
 797         {
 798                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 799                 *feerate_lock = feerate + 30;
 800         }
 801         nodes[0].node.timer_tick_occurred();
 802         check_added_monitors!(nodes[0], 1);
 803         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 804         assert_eq!(events_0.len(), 1);
 805         let (update_msg, commitment_signed) = match events_0[0] {
 806                         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 } } => {
 807                         (update_fee.as_ref(), commitment_signed)
 808                 },
 809                 _ => panic!("Unexpected event"),
 810         };
 811
 812         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 813         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 814         check_added_monitors!(nodes[1], 1);
 815         // ... creating (5)
 816         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 817         // No commitment_signed so get_event_msg's assert(len == 1) passes
 818
 819         // Handle (3), creating (6):
 820         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 821         check_added_monitors!(nodes[0], 1);
 822         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 823         // No commitment_signed so get_event_msg's assert(len == 1) passes
 824
 825         // Deliver (5):
 826         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 827         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 828         check_added_monitors!(nodes[0], 1);
 829
 830         // Deliver (6), creating (7):
 831         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 832         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 833         assert!(commitment_update.update_add_htlcs.is_empty());
 834         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 835         assert!(commitment_update.update_fail_htlcs.is_empty());
 836         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 837         assert!(commitment_update.update_fee.is_none());
 838         check_added_monitors!(nodes[1], 1);
 839
 840         // Deliver (7)
 841         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 842         check_added_monitors!(nodes[0], 1);
 843         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 844         // No commitment_signed so get_event_msg's assert(len == 1) passes
 845
 846         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 847         check_added_monitors!(nodes[1], 1);
 848         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 849
 850         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 851         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 852         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 853 }
 854
 855 #[test]
 856 fn fake_network_test() {
 857         // Simple test which builds a network of ChannelManagers, connects them to each other, and
 858         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
 859         let chanmon_cfgs = create_chanmon_cfgs(4);
 860         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
 861         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
 862         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
 863
 864         // Create some initial channels
 865         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 866         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 867         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
 868
 869         // Rebalance the network a bit by relaying one payment through all the channels...
 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         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
 874
 875         // Send some more payments
 876         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
 877         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
 878         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
 879
 880         // Test failure packets
 881         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
 882         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
 883
 884         // Add a new channel that skips 3
 885         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
 886
 887         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
 888         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
 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         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
 894
 895         // Do some rebalance loop payments, simultaneously
 896         let mut hops = Vec::with_capacity(3);
 897         hops.push(RouteHop {
 898                 pubkey: nodes[2].node.get_our_node_id(),
 899                 node_features: NodeFeatures::empty(),
 900                 short_channel_id: chan_2.0.contents.short_channel_id,
 901                 channel_features: ChannelFeatures::empty(),
 902                 fee_msat: 0,
 903                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
 904         });
 905         hops.push(RouteHop {
 906                 pubkey: nodes[3].node.get_our_node_id(),
 907                 node_features: NodeFeatures::empty(),
 908                 short_channel_id: chan_3.0.contents.short_channel_id,
 909                 channel_features: ChannelFeatures::empty(),
 910                 fee_msat: 0,
 911                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
 912         });
 913         hops.push(RouteHop {
 914                 pubkey: nodes[1].node.get_our_node_id(),
 915                 node_features: NodeFeatures::known(),
 916                 short_channel_id: chan_4.0.contents.short_channel_id,
 917                 channel_features: ChannelFeatures::known(),
 918                 fee_msat: 1000000,
 919                 cltv_expiry_delta: TEST_FINAL_CLTV,
 920         });
 921         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;
 922         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;
 923         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
 924
 925         let mut hops = Vec::with_capacity(3);
 926         hops.push(RouteHop {
 927                 pubkey: nodes[3].node.get_our_node_id(),
 928                 node_features: NodeFeatures::empty(),
 929                 short_channel_id: chan_4.0.contents.short_channel_id,
 930                 channel_features: ChannelFeatures::empty(),
 931                 fee_msat: 0,
 932                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
 933         });
 934         hops.push(RouteHop {
 935                 pubkey: nodes[2].node.get_our_node_id(),
 936                 node_features: NodeFeatures::empty(),
 937                 short_channel_id: chan_3.0.contents.short_channel_id,
 938                 channel_features: ChannelFeatures::empty(),
 939                 fee_msat: 0,
 940                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
 941         });
 942         hops.push(RouteHop {
 943                 pubkey: nodes[1].node.get_our_node_id(),
 944                 node_features: NodeFeatures::known(),
 945                 short_channel_id: chan_2.0.contents.short_channel_id,
 946                 channel_features: ChannelFeatures::known(),
 947                 fee_msat: 1000000,
 948                 cltv_expiry_delta: TEST_FINAL_CLTV,
 949         });
 950         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;
 951         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;
 952         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
 953
 954         // Claim the rebalances...
 955         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
 956         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
 957
 958         // Add a duplicate new channel from 2 to 4
 959         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
 960
 961         // Send some payments across both channels
 962         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
 963         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
 964         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
 965
 966
 967         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
 968         let events = nodes[0].node.get_and_clear_pending_msg_events();
 969         assert_eq!(events.len(), 0);
 970         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);
 971
 972         //TODO: Test that routes work again here as we've been notified that the channel is full
 973
 974         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
 975         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
 976         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
 977
 978         // Close down the channels...
 979         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
 980         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
 981         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
 982         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
 983         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
 984 }
 985
 986 #[test]
 987 fn holding_cell_htlc_counting() {
 988         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
 989         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
 990         // commitment dance rounds.
 991         let chanmon_cfgs = create_chanmon_cfgs(3);
 992         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 993         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 994         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 995         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 996         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 997         let logger = test_utils::TestLogger::new();
 998
 999         let mut payments = Vec::new();
1000         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1001                 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
1002                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1003                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1004                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
1005                 payments.push((payment_preimage, payment_hash));
1006         }
1007         check_added_monitors!(nodes[1], 1);
1008
1009         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1010         assert_eq!(events.len(), 1);
1011         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1012         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1013
1014         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1015         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1016         // another HTLC.
1017         let (_, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[2]);
1018         {
1019                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1020                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1021                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable { ref err },
1022                         assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1023                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1024                 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1025         }
1026
1027         // This should also be true if we try to forward a payment.
1028         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[2]);
1029         {
1030                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1031                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1032                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1033                 check_added_monitors!(nodes[0], 1);
1034         }
1035
1036         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1037         assert_eq!(events.len(), 1);
1038         let payment_event = SendEvent::from_event(events.pop().unwrap());
1039         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1040
1041         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1042         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1043         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1044         // fails), the second will process the resulting failure and fail the HTLC backward.
1045         expect_pending_htlcs_forwardable!(nodes[1]);
1046         expect_pending_htlcs_forwardable!(nodes[1]);
1047         check_added_monitors!(nodes[1], 1);
1048
1049         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1050         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1051         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1052
1053         expect_payment_failed_with_update!(nodes[0], payment_hash_2, false, chan_2.0.contents.short_channel_id, false);
1054
1055         // Now forward all the pending HTLCs and claim them back
1056         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1057         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1058         check_added_monitors!(nodes[2], 1);
1059
1060         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1061         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1062         check_added_monitors!(nodes[1], 1);
1063         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1064
1065         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1066         check_added_monitors!(nodes[1], 1);
1067         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1068
1069         for ref update in as_updates.update_add_htlcs.iter() {
1070                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1071         }
1072         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1073         check_added_monitors!(nodes[2], 1);
1074         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1075         check_added_monitors!(nodes[2], 1);
1076         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1077
1078         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1079         check_added_monitors!(nodes[1], 1);
1080         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1081         check_added_monitors!(nodes[1], 1);
1082         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1083
1084         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1085         check_added_monitors!(nodes[2], 1);
1086
1087         expect_pending_htlcs_forwardable!(nodes[2]);
1088
1089         let events = nodes[2].node.get_and_clear_pending_events();
1090         assert_eq!(events.len(), payments.len());
1091         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1092                 match event {
1093                         &Event::PaymentReceived { ref payment_hash, .. } => {
1094                                 assert_eq!(*payment_hash, *hash);
1095                         },
1096                         _ => panic!("Unexpected event"),
1097                 };
1098         }
1099
1100         for (preimage, _) in payments.drain(..) {
1101                 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1102         }
1103
1104         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1105 }
1106
1107 #[test]
1108 fn duplicate_htlc_test() {
1109         // Test that we accept duplicate payment_hash HTLCs across the network and that
1110         // claiming/failing them are all separate and don't affect each other
1111         let chanmon_cfgs = create_chanmon_cfgs(6);
1112         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1113         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1114         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1115
1116         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1117         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1118         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1119         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1120         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1121         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1122
1123         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1124
1125         *nodes[0].network_payment_count.borrow_mut() -= 1;
1126         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1127
1128         *nodes[0].network_payment_count.borrow_mut() -= 1;
1129         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1130
1131         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1132         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1133         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1134 }
1135
1136 #[test]
1137 fn test_duplicate_htlc_different_direction_onchain() {
1138         // Test that ChannelMonitor doesn't generate 2 preimage txn
1139         // when we have 2 HTLCs with same preimage that go across a node
1140         // in opposite directions, even with the same payment secret.
1141         let chanmon_cfgs = create_chanmon_cfgs(2);
1142         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1143         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1144         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1145
1146         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1147         let logger = test_utils::TestLogger::new();
1148
1149         // balancing
1150         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1151
1152         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1153
1154         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1155         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 800_000, TEST_FINAL_CLTV, &logger).unwrap();
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         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
1180
1181         // Check we only broadcast 1 timeout tx
1182         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1183         assert_eq!(claim_txn.len(), 8);
1184         assert_eq!(claim_txn[1], claim_txn[4]);
1185         assert_eq!(claim_txn[2], claim_txn[5]);
1186         check_spends!(claim_txn[1], chan_1.3);
1187         check_spends!(claim_txn[2], claim_txn[1]);
1188         check_spends!(claim_txn[7], claim_txn[1]);
1189
1190         assert_eq!(claim_txn[0].input.len(), 1);
1191         assert_eq!(claim_txn[3].input.len(), 1);
1192         assert_eq!(claim_txn[0].input[0].previous_output, claim_txn[3].input[0].previous_output);
1193
1194         assert_eq!(claim_txn[0].input.len(), 1);
1195         assert_eq!(claim_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1196         check_spends!(claim_txn[0], remote_txn[0]);
1197         assert_eq!(remote_txn[0].output[claim_txn[0].input[0].previous_output.vout as usize].value, 800);
1198         assert_eq!(claim_txn[6].input.len(), 1);
1199         assert_eq!(claim_txn[6].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1200         check_spends!(claim_txn[6], remote_txn[0]);
1201         assert_eq!(remote_txn[0].output[claim_txn[6].input[0].previous_output.vout as usize].value, 900);
1202
1203         let events = nodes[0].node.get_and_clear_pending_msg_events();
1204         assert_eq!(events.len(), 3);
1205         for e in events {
1206                 match e {
1207                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1208                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1209                                 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1210                                 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1211                         },
1212                         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, .. } } => {
1213                                 assert!(update_add_htlcs.is_empty());
1214                                 assert!(update_fail_htlcs.is_empty());
1215                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1216                                 assert!(update_fail_malformed_htlcs.is_empty());
1217                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1218                         },
1219                         _ => panic!("Unexpected event"),
1220                 }
1221         }
1222 }
1223
1224 #[test]
1225 fn test_basic_channel_reserve() {
1226         let chanmon_cfgs = create_chanmon_cfgs(2);
1227         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1228         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1229         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1230         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1231         let logger = test_utils::TestLogger::new();
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 (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
1238         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1239         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1240         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1241         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1242         let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).err().unwrap();
1243         match err {
1244                 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1245                         match &fails[0] {
1246                                 &APIError::ChannelUnavailable{ref err} =>
1247                                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1248                                 _ => panic!("Unexpected error variant"),
1249                         }
1250                 },
1251                 _ => panic!("Unexpected error variant"),
1252         }
1253         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1254         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);
1255
1256         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1257 }
1258
1259 #[test]
1260 fn test_fee_spike_violation_fails_htlc() {
1261         let chanmon_cfgs = create_chanmon_cfgs(2);
1262         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1263         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1264         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1265         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1266
1267         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1268         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1269         let secp_ctx = Secp256k1::new();
1270         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1271
1272         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1273
1274         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1275         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height, &None).unwrap();
1276         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1277         let msg = msgs::UpdateAddHTLC {
1278                 channel_id: chan.2,
1279                 htlc_id: 0,
1280                 amount_msat: htlc_msat,
1281                 payment_hash: payment_hash,
1282                 cltv_expiry: htlc_cltv,
1283                 onion_routing_packet: onion_packet,
1284         };
1285
1286         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1287
1288         // Now manually create the commitment_signed message corresponding to the update_add
1289         // nodes[0] just sent. In the code for construction of this message, "local" refers
1290         // to the sender of the message, and "remote" refers to the receiver.
1291
1292         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1293
1294         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1295
1296         // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1297         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1298         let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point, local_funding) = {
1299                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1300                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1301                 let chan_signer = local_chan.get_signer();
1302                 // Make the signer believe we validated another commitment, so we can release the secret
1303                 chan_signer.get_enforcement_state().last_holder_commitment -= 1;
1304
1305                 let pubkeys = chan_signer.pubkeys();
1306                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1307                  chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1308                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx),
1309                  chan_signer.pubkeys().funding_pubkey)
1310         };
1311         let (remote_delayed_payment_basepoint, remote_htlc_basepoint, remote_point, remote_funding) = {
1312                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1313                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1314                 let chan_signer = remote_chan.get_signer();
1315                 let pubkeys = chan_signer.pubkeys();
1316                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1317                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx),
1318                  chan_signer.pubkeys().funding_pubkey)
1319         };
1320
1321         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1322         let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1323                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1324
1325         // Build the remote commitment transaction so we can sign it, and then later use the
1326         // signature for the commitment_signed message.
1327         let local_chan_balance = 1313;
1328
1329         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1330                 offered: false,
1331                 amount_msat: 3460001,
1332                 cltv_expiry: htlc_cltv,
1333                 payment_hash,
1334                 transaction_output_index: Some(1),
1335         };
1336
1337         let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1338
1339         let res = {
1340                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1341                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1342                 let local_chan_signer = local_chan.get_signer();
1343                 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1344                         commitment_number,
1345                         95000,
1346                         local_chan_balance,
1347                         false, local_funding, remote_funding,
1348                         commit_tx_keys.clone(),
1349                         feerate_per_kw,
1350                         &mut vec![(accepted_htlc_info, ())],
1351                         &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1352                 );
1353                 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1354         };
1355
1356         let commit_signed_msg = msgs::CommitmentSigned {
1357                 channel_id: chan.2,
1358                 signature: res.0,
1359                 htlc_signatures: res.1
1360         };
1361
1362         // Send the commitment_signed message to the nodes[1].
1363         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1364         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1365
1366         // Send the RAA to nodes[1].
1367         let raa_msg = msgs::RevokeAndACK {
1368                 channel_id: chan.2,
1369                 per_commitment_secret: local_secret,
1370                 next_per_commitment_point: next_local_point
1371         };
1372         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1373
1374         let events = nodes[1].node.get_and_clear_pending_msg_events();
1375         assert_eq!(events.len(), 1);
1376         // Make sure the HTLC failed in the way we expect.
1377         match events[0] {
1378                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1379                         assert_eq!(update_fail_htlcs.len(), 1);
1380                         update_fail_htlcs[0].clone()
1381                 },
1382                 _ => panic!("Unexpected event"),
1383         };
1384         nodes[1].logger.assert_log("lightning::ln::channel".to_string(),
1385                 format!("Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", ::hex::encode(raa_msg.channel_id)), 1);
1386
1387         check_added_monitors!(nodes[1], 2);
1388 }
1389
1390 #[test]
1391 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1392         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1393         // Set the fee rate for the channel very high, to the point where the fundee
1394         // sending any above-dust amount would result in a channel reserve violation.
1395         // In this test we check that we would be prevented from sending an HTLC in
1396         // this situation.
1397         let feerate_per_kw = 253;
1398         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1399         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1400         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1401         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1402         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1403
1404         let mut push_amt = 100_000_000;
1405         push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000 * 1000;
1406         push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1407
1408         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, push_amt, InitFeatures::known(), InitFeatures::known());
1409
1410         // Sending exactly enough to hit the reserve amount should be accepted
1411         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], 1_000_000);
1412
1413         // However one more HTLC should be significantly over the reserve amount and fail.
1414         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1_000_000);
1415         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1416                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1417         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1418         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);
1419 }
1420
1421 #[test]
1422 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1423         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1424         // Set the fee rate for the channel very high, to the point where the funder
1425         // receiving 1 update_add_htlc would result in them closing the channel due
1426         // to channel reserve violation. This close could also happen if the fee went
1427         // up a more realistic amount, but many HTLCs were outstanding at the time of
1428         // the update_add_htlc.
1429         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1430         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1431         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1432         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1433         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1434         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1435
1436         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1437         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1438         let secp_ctx = Secp256k1::new();
1439         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1440         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1441         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1442         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height, &None).unwrap();
1443         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1444         let msg = msgs::UpdateAddHTLC {
1445                 channel_id: chan.2,
1446                 htlc_id: 1,
1447                 amount_msat: htlc_msat + 1,
1448                 payment_hash: payment_hash,
1449                 cltv_expiry: htlc_cltv,
1450                 onion_routing_packet: onion_packet,
1451         };
1452
1453         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1454         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1455         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);
1456         assert_eq!(nodes[0].node.list_channels().len(), 0);
1457         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1458         assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1459         check_added_monitors!(nodes[0], 1);
1460 }
1461
1462 #[test]
1463 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1464         // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1465         // calculating our commitment transaction fee (this was previously broken).
1466         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1467         let feerate_per_kw = 253;
1468         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1469         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1470
1471         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1472         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1473         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1474
1475         // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1476         // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1477         // transaction fee with 0 HTLCs (183 sats)).
1478         let mut push_amt = 100_000_000;
1479         push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT) / 1000 * 1000;
1480         push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1481         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, push_amt, InitFeatures::known(), InitFeatures::known());
1482
1483         let dust_amt = crate::ln::channel::MIN_DUST_LIMIT_SATOSHIS * 1000
1484                 + feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000 * 1000 - 1;
1485         // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1486         // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1487         // commitment transaction fee.
1488         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1489
1490         // One more than the dust amt should fail, however.
1491         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], dust_amt + 1);
1492         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1493                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1494 }
1495
1496 #[test]
1497 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1498         // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1499         // calculating our counterparty's commitment transaction fee (this was previously broken).
1500         let chanmon_cfgs = create_chanmon_cfgs(2);
1501         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1502         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1503         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1504         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1505
1506         let payment_amt = 46000; // Dust amount
1507         // In the previous code, these first four payments would succeed.
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         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1512
1513         // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
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         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1519
1520         // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1521         // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1522         // transaction fee and therefore perceived this next payment as a channel reserve violation.
1523         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1524 }
1525
1526 #[test]
1527 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1528         let chanmon_cfgs = create_chanmon_cfgs(3);
1529         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1530         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1531         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1532         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1533         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1534
1535         let feemsat = 239;
1536         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1537         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1538         let feerate = get_feerate!(nodes[0], chan.2);
1539
1540         // Add a 2* and +1 for the fee spike reserve.
1541         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1542         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;
1543         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1544
1545         // Add a pending HTLC.
1546         let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1547         let payment_event_1 = {
1548                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1549                 check_added_monitors!(nodes[0], 1);
1550
1551                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1552                 assert_eq!(events.len(), 1);
1553                 SendEvent::from_event(events.remove(0))
1554         };
1555         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1556
1557         // Attempt to trigger a channel reserve violation --> payment failure.
1558         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1559         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;
1560         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1561         let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1562
1563         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1564         let secp_ctx = Secp256k1::new();
1565         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1566         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1567         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1568         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height, &None).unwrap();
1569         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1570         let msg = msgs::UpdateAddHTLC {
1571                 channel_id: chan.2,
1572                 htlc_id: 1,
1573                 amount_msat: htlc_msat + 1,
1574                 payment_hash: our_payment_hash_1,
1575                 cltv_expiry: htlc_cltv,
1576                 onion_routing_packet: onion_packet,
1577         };
1578
1579         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1580         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1581         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1582         assert_eq!(nodes[1].node.list_channels().len(), 1);
1583         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1584         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1585         check_added_monitors!(nodes[1], 1);
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         let logger = test_utils::TestLogger::new();
1877
1878         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1879         // Route the first two HTLCs.
1880         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1881         let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1882
1883         // Start routing the third HTLC (this is just used to get everyone in the right state).
1884         let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
1885         let send_1 = {
1886                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1887                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
1888                 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
1889                 check_added_monitors!(nodes[0], 1);
1890                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1891                 assert_eq!(events.len(), 1);
1892                 SendEvent::from_event(events.remove(0))
1893         };
1894
1895         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1896         // initial fulfill/CS.
1897         assert!(nodes[1].node.claim_funds(payment_preimage_1));
1898         check_added_monitors!(nodes[1], 1);
1899         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1900
1901         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1902         // remove the second HTLC when we send the HTLC back from B to A.
1903         assert!(nodes[1].node.claim_funds(payment_preimage_2));
1904         check_added_monitors!(nodes[1], 1);
1905         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1906
1907         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
1908         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
1909         check_added_monitors!(nodes[0], 1);
1910         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1911         expect_payment_sent!(nodes[0], payment_preimage_1);
1912
1913         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
1914         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
1915         check_added_monitors!(nodes[1], 1);
1916         // B is already AwaitingRAA, so cant generate a CS here
1917         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1918
1919         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1920         check_added_monitors!(nodes[1], 1);
1921         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1922
1923         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1924         check_added_monitors!(nodes[0], 1);
1925         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1926
1927         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1928         check_added_monitors!(nodes[1], 1);
1929         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1930
1931         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1932         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1933         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1934         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1935         // on-chain as necessary).
1936         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
1937         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
1938         check_added_monitors!(nodes[0], 1);
1939         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1940         expect_payment_sent!(nodes[0], payment_preimage_2);
1941
1942         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1943         check_added_monitors!(nodes[1], 1);
1944         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1945
1946         expect_pending_htlcs_forwardable!(nodes[1]);
1947         expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
1948
1949         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1950         // resolve the second HTLC from A's point of view.
1951         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1952         check_added_monitors!(nodes[0], 1);
1953         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1954
1955         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1956         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1957         let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
1958         let send_2 = {
1959                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1960                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 10000, TEST_FINAL_CLTV, &logger).unwrap();
1961                 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
1962                 check_added_monitors!(nodes[1], 1);
1963                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1964                 assert_eq!(events.len(), 1);
1965                 SendEvent::from_event(events.remove(0))
1966         };
1967
1968         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
1969         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
1970         check_added_monitors!(nodes[0], 1);
1971         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1972
1973         // Now just resolve all the outstanding messages/HTLCs for completeness...
1974
1975         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1976         check_added_monitors!(nodes[1], 1);
1977         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1978
1979         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1980         check_added_monitors!(nodes[1], 1);
1981
1982         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1983         check_added_monitors!(nodes[0], 1);
1984         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1985
1986         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1987         check_added_monitors!(nodes[1], 1);
1988         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1989
1990         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1991         check_added_monitors!(nodes[0], 1);
1992
1993         expect_pending_htlcs_forwardable!(nodes[0]);
1994         expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
1995
1996         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
1997         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
1998 }
1999
2000 #[test]
2001 fn channel_monitor_network_test() {
2002         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2003         // tests that ChannelMonitor is able to recover from various states.
2004         let chanmon_cfgs = create_chanmon_cfgs(5);
2005         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2006         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2007         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2008
2009         // Create some initial channels
2010         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2011         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2012         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2013         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2014
2015         // Make sure all nodes are at the same starting height
2016         connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2017         connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2018         connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2019         connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2020         connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2021
2022         // Rebalance the network a bit by relaying one payment through all the channels...
2023         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2024         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2025         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2026         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2027
2028         // Simple case with no pending HTLCs:
2029         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2030         check_added_monitors!(nodes[1], 1);
2031         check_closed_broadcast!(nodes[1], false);
2032         {
2033                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2034                 assert_eq!(node_txn.len(), 1);
2035                 mine_transaction(&nodes[0], &node_txn[0]);
2036                 check_added_monitors!(nodes[0], 1);
2037                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2038         }
2039         check_closed_broadcast!(nodes[0], true);
2040         assert_eq!(nodes[0].node.list_channels().len(), 0);
2041         assert_eq!(nodes[1].node.list_channels().len(), 1);
2042
2043         // One pending HTLC is discarded by the force-close:
2044         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2045
2046         // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2047         // broadcasted until we reach the timelock time).
2048         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2049         check_closed_broadcast!(nodes[1], false);
2050         check_added_monitors!(nodes[1], 1);
2051         {
2052                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2053                 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2054                 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2055                 mine_transaction(&nodes[2], &node_txn[0]);
2056                 check_added_monitors!(nodes[2], 1);
2057                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2058         }
2059         check_closed_broadcast!(nodes[2], true);
2060         assert_eq!(nodes[1].node.list_channels().len(), 0);
2061         assert_eq!(nodes[2].node.list_channels().len(), 1);
2062
2063         macro_rules! claim_funds {
2064                 ($node: expr, $prev_node: expr, $preimage: expr) => {
2065                         {
2066                                 assert!($node.node.claim_funds($preimage));
2067                                 check_added_monitors!($node, 1);
2068
2069                                 let events = $node.node.get_and_clear_pending_msg_events();
2070                                 assert_eq!(events.len(), 1);
2071                                 match events[0] {
2072                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2073                                                 assert!(update_add_htlcs.is_empty());
2074                                                 assert!(update_fail_htlcs.is_empty());
2075                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2076                                         },
2077                                         _ => panic!("Unexpected event"),
2078                                 };
2079                         }
2080                 }
2081         }
2082
2083         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2084         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2085         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2086         check_added_monitors!(nodes[2], 1);
2087         check_closed_broadcast!(nodes[2], false);
2088         let node2_commitment_txid;
2089         {
2090                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2091                 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2092                 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2093                 node2_commitment_txid = node_txn[0].txid();
2094
2095                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2096                 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2097                 mine_transaction(&nodes[3], &node_txn[0]);
2098                 check_added_monitors!(nodes[3], 1);
2099                 check_preimage_claim(&nodes[3], &node_txn);
2100         }
2101         check_closed_broadcast!(nodes[3], true);
2102         assert_eq!(nodes[2].node.list_channels().len(), 0);
2103         assert_eq!(nodes[3].node.list_channels().len(), 1);
2104
2105         // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2106         // confusing us in the following tests.
2107         let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2108
2109         // One pending HTLC to time out:
2110         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2111         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2112         // buffer space).
2113
2114         let (close_chan_update_1, close_chan_update_2) = {
2115                 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2116                 let events = nodes[3].node.get_and_clear_pending_msg_events();
2117                 assert_eq!(events.len(), 2);
2118                 let close_chan_update_1 = match events[0] {
2119                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2120                                 msg.clone()
2121                         },
2122                         _ => panic!("Unexpected event"),
2123                 };
2124                 match events[1] {
2125                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2126                                 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2127                         },
2128                         _ => panic!("Unexpected event"),
2129                 }
2130                 check_added_monitors!(nodes[3], 1);
2131
2132                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2133                 {
2134                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2135                         node_txn.retain(|tx| {
2136                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2137                                         false
2138                                 } else { true }
2139                         });
2140                 }
2141
2142                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2143
2144                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2145                 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2146
2147                 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2148                 let events = nodes[4].node.get_and_clear_pending_msg_events();
2149                 assert_eq!(events.len(), 2);
2150                 let close_chan_update_2 = match events[0] {
2151                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2152                                 msg.clone()
2153                         },
2154                         _ => panic!("Unexpected event"),
2155                 };
2156                 match events[1] {
2157                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2158                                 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2159                         },
2160                         _ => panic!("Unexpected event"),
2161                 }
2162                 check_added_monitors!(nodes[4], 1);
2163                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2164
2165                 mine_transaction(&nodes[4], &node_txn[0]);
2166                 check_preimage_claim(&nodes[4], &node_txn);
2167                 (close_chan_update_1, close_chan_update_2)
2168         };
2169         nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2170         nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2171         assert_eq!(nodes[3].node.list_channels().len(), 0);
2172         assert_eq!(nodes[4].node.list_channels().len(), 0);
2173
2174         nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2175 }
2176
2177 #[test]
2178 fn test_justice_tx() {
2179         // Test justice txn built on revoked HTLC-Success tx, against both sides
2180         let mut alice_config = UserConfig::default();
2181         alice_config.channel_options.announced_channel = true;
2182         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2183         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2184         let mut bob_config = UserConfig::default();
2185         bob_config.channel_options.announced_channel = true;
2186         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2187         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2188         let user_cfgs = [Some(alice_config), Some(bob_config)];
2189         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2190         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2191         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2192         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2193         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2194         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2195         // Create some new channels:
2196         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2197
2198         // A pending HTLC which will be revoked:
2199         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2200         // Get the will-be-revoked local txn from nodes[0]
2201         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2202         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2203         assert_eq!(revoked_local_txn[0].input.len(), 1);
2204         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2205         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2206         assert_eq!(revoked_local_txn[1].input.len(), 1);
2207         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2208         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2209         // Revoke the old state
2210         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2211
2212         {
2213                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2214                 {
2215                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2216                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2217                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2218
2219                         check_spends!(node_txn[0], revoked_local_txn[0]);
2220                         node_txn.swap_remove(0);
2221                         node_txn.truncate(1);
2222                 }
2223                 check_added_monitors!(nodes[1], 1);
2224                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2225
2226                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2227                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2228                 // Verify broadcast of revoked HTLC-timeout
2229                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2230                 check_added_monitors!(nodes[0], 1);
2231                 // Broadcast revoked HTLC-timeout on node 1
2232                 mine_transaction(&nodes[1], &node_txn[1]);
2233                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2234         }
2235         get_announce_close_broadcast_events(&nodes, 0, 1);
2236
2237         assert_eq!(nodes[0].node.list_channels().len(), 0);
2238         assert_eq!(nodes[1].node.list_channels().len(), 0);
2239
2240         // We test justice_tx build by A on B's revoked HTLC-Success tx
2241         // Create some new channels:
2242         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2243         {
2244                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2245                 node_txn.clear();
2246         }
2247
2248         // A pending HTLC which will be revoked:
2249         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2250         // Get the will-be-revoked local txn from B
2251         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2252         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2253         assert_eq!(revoked_local_txn[0].input.len(), 1);
2254         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2255         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2256         // Revoke the old state
2257         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2258         {
2259                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2260                 {
2261                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2262                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2263                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2264
2265                         check_spends!(node_txn[0], revoked_local_txn[0]);
2266                         node_txn.swap_remove(0);
2267                 }
2268                 check_added_monitors!(nodes[0], 1);
2269                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2270
2271                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2272                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2273                 check_added_monitors!(nodes[1], 1);
2274                 mine_transaction(&nodes[0], &node_txn[1]);
2275                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2276         }
2277         get_announce_close_broadcast_events(&nodes, 0, 1);
2278         assert_eq!(nodes[0].node.list_channels().len(), 0);
2279         assert_eq!(nodes[1].node.list_channels().len(), 0);
2280 }
2281
2282 #[test]
2283 fn revoked_output_claim() {
2284         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2285         // transaction is broadcast by its counterparty
2286         let chanmon_cfgs = create_chanmon_cfgs(2);
2287         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2288         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2289         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2290         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2291         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2292         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2293         assert_eq!(revoked_local_txn.len(), 1);
2294         // Only output is the full channel value back to nodes[0]:
2295         assert_eq!(revoked_local_txn[0].output.len(), 1);
2296         // Send a payment through, updating everyone's latest commitment txn
2297         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2298
2299         // Inform nodes[1] that nodes[0] broadcast a stale tx
2300         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2301         check_added_monitors!(nodes[1], 1);
2302         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2303         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2304
2305         check_spends!(node_txn[0], revoked_local_txn[0]);
2306         check_spends!(node_txn[1], chan_1.3);
2307
2308         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2309         mine_transaction(&nodes[0], &revoked_local_txn[0]);
2310         get_announce_close_broadcast_events(&nodes, 0, 1);
2311         check_added_monitors!(nodes[0], 1)
2312 }
2313
2314 #[test]
2315 fn claim_htlc_outputs_shared_tx() {
2316         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2317         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2318         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2319         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2320         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2321         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2322
2323         // Create some new channel:
2324         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2325
2326         // Rebalance the network to generate htlc in the two directions
2327         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2328         // 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
2329         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2330         let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2331
2332         // Get the will-be-revoked local txn from node[0]
2333         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2334         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2335         assert_eq!(revoked_local_txn[0].input.len(), 1);
2336         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2337         assert_eq!(revoked_local_txn[1].input.len(), 1);
2338         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2339         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2340         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2341
2342         //Revoke the old state
2343         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2344
2345         {
2346                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2347                 check_added_monitors!(nodes[0], 1);
2348                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2349                 check_added_monitors!(nodes[1], 1);
2350                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2351                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2352
2353                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2354                 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment
2355
2356                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2357                 check_spends!(node_txn[0], revoked_local_txn[0]);
2358
2359                 let mut witness_lens = BTreeSet::new();
2360                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2361                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2362                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2363                 assert_eq!(witness_lens.len(), 3);
2364                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2365                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2366                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2367
2368                 // Next nodes[1] broadcasts its current local tx state:
2369                 assert_eq!(node_txn[1].input.len(), 1);
2370                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2371         }
2372         get_announce_close_broadcast_events(&nodes, 0, 1);
2373         assert_eq!(nodes[0].node.list_channels().len(), 0);
2374         assert_eq!(nodes[1].node.list_channels().len(), 0);
2375 }
2376
2377 #[test]
2378 fn claim_htlc_outputs_single_tx() {
2379         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2380         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2381         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2382         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2383         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2384         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2385
2386         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2387
2388         // Rebalance the network to generate htlc in the two directions
2389         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2390         // 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
2391         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2392         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2393         let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2394
2395         // Get the will-be-revoked local txn from node[0]
2396         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2397
2398         //Revoke the old state
2399         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2400
2401         {
2402                 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2403                 check_added_monitors!(nodes[0], 1);
2404                 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2405                 check_added_monitors!(nodes[1], 1);
2406                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2407
2408                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2409                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2410
2411                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2412                 assert_eq!(node_txn.len(), 9);
2413                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2414                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2415                 // 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)
2416                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2417
2418                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2419                 assert_eq!(node_txn[0].input.len(), 1);
2420                 check_spends!(node_txn[0], chan_1.3);
2421                 assert_eq!(node_txn[1].input.len(), 1);
2422                 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2423                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2424                 check_spends!(node_txn[1], node_txn[0]);
2425
2426                 // Justice transactions are indices 1-2-4
2427                 assert_eq!(node_txn[2].input.len(), 1);
2428                 assert_eq!(node_txn[3].input.len(), 1);
2429                 assert_eq!(node_txn[4].input.len(), 1);
2430
2431                 check_spends!(node_txn[2], revoked_local_txn[0]);
2432                 check_spends!(node_txn[3], revoked_local_txn[0]);
2433                 check_spends!(node_txn[4], revoked_local_txn[0]);
2434
2435                 let mut witness_lens = BTreeSet::new();
2436                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2437                 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2438                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2439                 assert_eq!(witness_lens.len(), 3);
2440                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2441                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2442                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2443         }
2444         get_announce_close_broadcast_events(&nodes, 0, 1);
2445         assert_eq!(nodes[0].node.list_channels().len(), 0);
2446         assert_eq!(nodes[1].node.list_channels().len(), 0);
2447 }
2448
2449 #[test]
2450 fn test_htlc_on_chain_success() {
2451         // Test that in case of a unilateral close onchain, we detect the state of output and pass
2452         // the preimage backward accordingly. So here we test that ChannelManager is
2453         // broadcasting the right event to other nodes in payment path.
2454         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2455         // A --------------------> B ----------------------> C (preimage)
2456         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2457         // commitment transaction was broadcast.
2458         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2459         // towards B.
2460         // B should be able to claim via preimage if A then broadcasts its local tx.
2461         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2462         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2463         // PaymentSent event).
2464
2465         let chanmon_cfgs = create_chanmon_cfgs(3);
2466         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2467         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2468         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2469
2470         // Create some initial channels
2471         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2472         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2473
2474         // Ensure all nodes are at the same height
2475         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2476         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2477         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2478         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2479
2480         // Rebalance the network a bit by relaying one payment through all the channels...
2481         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2482         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2483
2484         let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2485         let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2486
2487         // Broadcast legit commitment tx from C on B's chain
2488         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2489         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2490         assert_eq!(commitment_tx.len(), 1);
2491         check_spends!(commitment_tx[0], chan_2.3);
2492         nodes[2].node.claim_funds(our_payment_preimage);
2493         nodes[2].node.claim_funds(our_payment_preimage_2);
2494         check_added_monitors!(nodes[2], 2);
2495         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2496         assert!(updates.update_add_htlcs.is_empty());
2497         assert!(updates.update_fail_htlcs.is_empty());
2498         assert!(updates.update_fail_malformed_htlcs.is_empty());
2499         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2500
2501         mine_transaction(&nodes[2], &commitment_tx[0]);
2502         check_closed_broadcast!(nodes[2], true);
2503         check_added_monitors!(nodes[2], 1);
2504         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)
2505         assert_eq!(node_txn.len(), 5);
2506         assert_eq!(node_txn[0], node_txn[3]);
2507         assert_eq!(node_txn[1], node_txn[4]);
2508         assert_eq!(node_txn[2], commitment_tx[0]);
2509         check_spends!(node_txn[0], commitment_tx[0]);
2510         check_spends!(node_txn[1], commitment_tx[0]);
2511         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2512         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2513         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2514         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2515         assert_eq!(node_txn[0].lock_time, 0);
2516         assert_eq!(node_txn[1].lock_time, 0);
2517
2518         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2519         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2520         connect_block(&nodes[1], &Block { header, txdata: node_txn});
2521         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2522         {
2523                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2524                 assert_eq!(added_monitors.len(), 1);
2525                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2526                 added_monitors.clear();
2527         }
2528         let forwarded_events = nodes[1].node.get_and_clear_pending_events();
2529         assert_eq!(forwarded_events.len(), 2);
2530         if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[0] {
2531                 } else { panic!(); }
2532         if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[1] {
2533                 } else { panic!(); }
2534         let events = nodes[1].node.get_and_clear_pending_msg_events();
2535         {
2536                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2537                 assert_eq!(added_monitors.len(), 2);
2538                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2539                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2540                 added_monitors.clear();
2541         }
2542         assert_eq!(events.len(), 3);
2543         match events[0] {
2544                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2545                 _ => panic!("Unexpected event"),
2546         }
2547         match events[1] {
2548                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2549                 _ => panic!("Unexpected event"),
2550         }
2551
2552         match events[2] {
2553                 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, .. } } => {
2554                         assert!(update_add_htlcs.is_empty());
2555                         assert!(update_fail_htlcs.is_empty());
2556                         assert_eq!(update_fulfill_htlcs.len(), 1);
2557                         assert!(update_fail_malformed_htlcs.is_empty());
2558                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2559                 },
2560                 _ => panic!("Unexpected event"),
2561         };
2562         macro_rules! check_tx_local_broadcast {
2563                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2564                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2565                         assert_eq!(node_txn.len(), 3);
2566                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2567                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2568                         check_spends!(node_txn[1], $commitment_tx);
2569                         check_spends!(node_txn[2], $commitment_tx);
2570                         assert_ne!(node_txn[1].lock_time, 0);
2571                         assert_ne!(node_txn[2].lock_time, 0);
2572                         if $htlc_offered {
2573                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2574                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2575                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2576                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2577                         } else {
2578                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2579                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2580                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2581                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2582                         }
2583                         check_spends!(node_txn[0], $chan_tx);
2584                         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2585                         node_txn.clear();
2586                 } }
2587         }
2588         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2589         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2590         // timeout-claim of the output that nodes[2] just claimed via success.
2591         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2592
2593         // Broadcast legit commitment tx from A on B's chain
2594         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2595         let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2596         check_spends!(node_a_commitment_tx[0], chan_1.3);
2597         mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2598         check_closed_broadcast!(nodes[1], true);
2599         check_added_monitors!(nodes[1], 1);
2600         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2601         assert_eq!(node_txn.len(), 6); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 3 (HTLC-Success, 2* RBF bumps of above HTLC txn)
2602         let commitment_spend =
2603                 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2604                         check_spends!(node_txn[1], commitment_tx[0]);
2605                         check_spends!(node_txn[2], commitment_tx[0]);
2606                         assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2607                         &node_txn[0]
2608                 } else {
2609                         check_spends!(node_txn[0], commitment_tx[0]);
2610                         check_spends!(node_txn[1], commitment_tx[0]);
2611                         assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2612                         &node_txn[2]
2613                 };
2614
2615         check_spends!(commitment_spend, node_a_commitment_tx[0]);
2616         assert_eq!(commitment_spend.input.len(), 2);
2617         assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2618         assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2619         assert_eq!(commitment_spend.lock_time, 0);
2620         assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2621         check_spends!(node_txn[3], chan_1.3);
2622         assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2623         check_spends!(node_txn[4], node_txn[3]);
2624         check_spends!(node_txn[5], node_txn[3]);
2625         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2626         // we already checked the same situation with A.
2627
2628         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2629         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2630         connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
2631         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2632         check_closed_broadcast!(nodes[0], true);
2633         check_added_monitors!(nodes[0], 1);
2634         let events = nodes[0].node.get_and_clear_pending_events();
2635         assert_eq!(events.len(), 2);
2636         let mut first_claimed = false;
2637         for event in events {
2638                 match event {
2639                         Event::PaymentSent { payment_preimage } => {
2640                                 if payment_preimage == our_payment_preimage {
2641                                         assert!(!first_claimed);
2642                                         first_claimed = true;
2643                                 } else {
2644                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2645                                 }
2646                         },
2647                         _ => panic!("Unexpected event"),
2648                 }
2649         }
2650         check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0], chan_1.3);
2651 }
2652
2653 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2654         // Test that in case of a unilateral close onchain, we detect the state of output and
2655         // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2656         // broadcasting the right event to other nodes in payment path.
2657         // A ------------------> B ----------------------> C (timeout)
2658         //    B's commitment tx                 C's commitment tx
2659         //            \                                  \
2660         //         B's HTLC timeout tx               B's timeout tx
2661
2662         let chanmon_cfgs = create_chanmon_cfgs(3);
2663         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2664         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2665         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2666         *nodes[0].connect_style.borrow_mut() = connect_style;
2667         *nodes[1].connect_style.borrow_mut() = connect_style;
2668         *nodes[2].connect_style.borrow_mut() = connect_style;
2669
2670         // Create some intial channels
2671         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2672         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2673
2674         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2675         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2676         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2677
2678         let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2679
2680         // Broadcast legit commitment tx from C on B's chain
2681         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2682         check_spends!(commitment_tx[0], chan_2.3);
2683         nodes[2].node.fail_htlc_backwards(&payment_hash);
2684         check_added_monitors!(nodes[2], 0);
2685         expect_pending_htlcs_forwardable!(nodes[2]);
2686         check_added_monitors!(nodes[2], 1);
2687
2688         let events = nodes[2].node.get_and_clear_pending_msg_events();
2689         assert_eq!(events.len(), 1);
2690         match events[0] {
2691                 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, .. } } => {
2692                         assert!(update_add_htlcs.is_empty());
2693                         assert!(!update_fail_htlcs.is_empty());
2694                         assert!(update_fulfill_htlcs.is_empty());
2695                         assert!(update_fail_malformed_htlcs.is_empty());
2696                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2697                 },
2698                 _ => panic!("Unexpected event"),
2699         };
2700         mine_transaction(&nodes[2], &commitment_tx[0]);
2701         check_closed_broadcast!(nodes[2], true);
2702         check_added_monitors!(nodes[2], 1);
2703         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2704         assert_eq!(node_txn.len(), 1);
2705         check_spends!(node_txn[0], chan_2.3);
2706         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2707
2708         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2709         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2710         connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2711         mine_transaction(&nodes[1], &commitment_tx[0]);
2712         let timeout_tx;
2713         {
2714                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2715                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2716                 assert_eq!(node_txn[0], node_txn[3]);
2717                 assert_eq!(node_txn[1], node_txn[4]);
2718
2719                 check_spends!(node_txn[2], commitment_tx[0]);
2720                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2721
2722                 check_spends!(node_txn[0], chan_2.3);
2723                 check_spends!(node_txn[1], node_txn[0]);
2724                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2725                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2726
2727                 timeout_tx = node_txn[2].clone();
2728                 node_txn.clear();
2729         }
2730
2731         mine_transaction(&nodes[1], &timeout_tx);
2732         check_added_monitors!(nodes[1], 1);
2733         check_closed_broadcast!(nodes[1], true);
2734         {
2735                 // B will rebroadcast a fee-bumped timeout transaction here.
2736                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2737                 assert_eq!(node_txn.len(), 1);
2738                 check_spends!(node_txn[0], commitment_tx[0]);
2739         }
2740
2741         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2742         {
2743                 // B may rebroadcast its own holder commitment transaction here, as a safeguard against
2744                 // some incredibly unlikely partial-eclipse-attack scenarios. That said, because the
2745                 // original commitment_tx[0] (also spending chan_2.3) has reached ANTI_REORG_DELAY B really
2746                 // shouldn't broadcast anything here, and in some connect style scenarios we do not.
2747                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2748                 if node_txn.len() == 1 {
2749                         check_spends!(node_txn[0], chan_2.3);
2750                 } else {
2751                         assert_eq!(node_txn.len(), 0);
2752                 }
2753         }
2754
2755         expect_pending_htlcs_forwardable!(nodes[1]);
2756         check_added_monitors!(nodes[1], 1);
2757         let events = nodes[1].node.get_and_clear_pending_msg_events();
2758         assert_eq!(events.len(), 1);
2759         match events[0] {
2760                 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, .. } } => {
2761                         assert!(update_add_htlcs.is_empty());
2762                         assert!(!update_fail_htlcs.is_empty());
2763                         assert!(update_fulfill_htlcs.is_empty());
2764                         assert!(update_fail_malformed_htlcs.is_empty());
2765                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2766                 },
2767                 _ => panic!("Unexpected event"),
2768         };
2769
2770         // Broadcast legit commitment tx from B on A's chain
2771         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
2772         check_spends!(commitment_tx[0], chan_1.3);
2773
2774         mine_transaction(&nodes[0], &commitment_tx[0]);
2775         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2776
2777         check_closed_broadcast!(nodes[0], true);
2778         check_added_monitors!(nodes[0], 1);
2779         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 commitment tx, ChannelMonitor : 1 timeout tx
2780         assert_eq!(node_txn.len(), 2);
2781         check_spends!(node_txn[0], chan_1.3);
2782         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2783         check_spends!(node_txn[1], commitment_tx[0]);
2784         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2785 }
2786
2787 #[test]
2788 fn test_htlc_on_chain_timeout() {
2789         do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
2790         do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
2791         do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
2792 }
2793
2794 #[test]
2795 fn test_simple_commitment_revoked_fail_backward() {
2796         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2797         // and fail backward accordingly.
2798
2799         let chanmon_cfgs = create_chanmon_cfgs(3);
2800         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2801         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2802         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2803
2804         // Create some initial channels
2805         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2806         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2807
2808         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2809         // Get the will-be-revoked local txn from nodes[2]
2810         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2811         // Revoke the old state
2812         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
2813
2814         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2815
2816         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2817         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2818         check_added_monitors!(nodes[1], 1);
2819         check_closed_broadcast!(nodes[1], true);
2820
2821         expect_pending_htlcs_forwardable!(nodes[1]);
2822         check_added_monitors!(nodes[1], 1);
2823         let events = nodes[1].node.get_and_clear_pending_msg_events();
2824         assert_eq!(events.len(), 1);
2825         match events[0] {
2826                 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, .. } } => {
2827                         assert!(update_add_htlcs.is_empty());
2828                         assert_eq!(update_fail_htlcs.len(), 1);
2829                         assert!(update_fulfill_htlcs.is_empty());
2830                         assert!(update_fail_malformed_htlcs.is_empty());
2831                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2832
2833                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2834                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2835                         expect_payment_failed_with_update!(nodes[0], payment_hash, false, chan_2.0.contents.short_channel_id, true);
2836                 },
2837                 _ => panic!("Unexpected event"),
2838         }
2839 }
2840
2841 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2842         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2843         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2844         // commitment transaction anymore.
2845         // To do this, we have the peer which will broadcast a revoked commitment transaction send
2846         // a number of update_fail/commitment_signed updates without ever sending the RAA in
2847         // response to our commitment_signed. This is somewhat misbehavior-y, though not
2848         // technically disallowed and we should probably handle it reasonably.
2849         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2850         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2851         // transactions:
2852         // * Once we move it out of our holding cell/add it, we will immediately include it in a
2853         //   commitment_signed (implying it will be in the latest remote commitment transaction).
2854         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2855         //   and once they revoke the previous commitment transaction (allowing us to send a new
2856         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2857         let chanmon_cfgs = create_chanmon_cfgs(3);
2858         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2859         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2860         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2861
2862         // Create some initial channels
2863         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2864         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2865
2866         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 });
2867         // Get the will-be-revoked local txn from nodes[2]
2868         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2869         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2870         // Revoke the old state
2871         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
2872
2873         let value = if use_dust {
2874                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2875                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2876                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
2877         } else { 3000000 };
2878
2879         let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2880         let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2881         let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2882
2883         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
2884         expect_pending_htlcs_forwardable!(nodes[2]);
2885         check_added_monitors!(nodes[2], 1);
2886         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2887         assert!(updates.update_add_htlcs.is_empty());
2888         assert!(updates.update_fulfill_htlcs.is_empty());
2889         assert!(updates.update_fail_malformed_htlcs.is_empty());
2890         assert_eq!(updates.update_fail_htlcs.len(), 1);
2891         assert!(updates.update_fee.is_none());
2892         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2893         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2894         // Drop the last RAA from 3 -> 2
2895
2896         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
2897         expect_pending_htlcs_forwardable!(nodes[2]);
2898         check_added_monitors!(nodes[2], 1);
2899         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2900         assert!(updates.update_add_htlcs.is_empty());
2901         assert!(updates.update_fulfill_htlcs.is_empty());
2902         assert!(updates.update_fail_malformed_htlcs.is_empty());
2903         assert_eq!(updates.update_fail_htlcs.len(), 1);
2904         assert!(updates.update_fee.is_none());
2905         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2906         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2907         check_added_monitors!(nodes[1], 1);
2908         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2909         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2910         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2911         check_added_monitors!(nodes[2], 1);
2912
2913         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
2914         expect_pending_htlcs_forwardable!(nodes[2]);
2915         check_added_monitors!(nodes[2], 1);
2916         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2917         assert!(updates.update_add_htlcs.is_empty());
2918         assert!(updates.update_fulfill_htlcs.is_empty());
2919         assert!(updates.update_fail_malformed_htlcs.is_empty());
2920         assert_eq!(updates.update_fail_htlcs.len(), 1);
2921         assert!(updates.update_fee.is_none());
2922         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2923         // At this point first_payment_hash has dropped out of the latest two commitment
2924         // transactions that nodes[1] is tracking...
2925         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2926         check_added_monitors!(nodes[1], 1);
2927         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2928         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2929         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2930         check_added_monitors!(nodes[2], 1);
2931
2932         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2933         // on nodes[2]'s RAA.
2934         let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
2935         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2936         let logger = test_utils::TestLogger::new();
2937         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
2938         nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
2939         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2940         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2941         check_added_monitors!(nodes[1], 0);
2942
2943         if deliver_bs_raa {
2944                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
2945                 // One monitor for the new revocation preimage, no second on as we won't generate a new
2946                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2947                 check_added_monitors!(nodes[1], 1);
2948                 let events = nodes[1].node.get_and_clear_pending_events();
2949                 assert_eq!(events.len(), 1);
2950                 match events[0] {
2951                         Event::PendingHTLCsForwardable { .. } => { },
2952                         _ => panic!("Unexpected event"),
2953                 };
2954                 // Deliberately don't process the pending fail-back so they all fail back at once after
2955                 // block connection just like the !deliver_bs_raa case
2956         }
2957
2958         let mut failed_htlcs = HashSet::new();
2959         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2960
2961         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2962         check_added_monitors!(nodes[1], 1);
2963         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2964
2965         let events = nodes[1].node.get_and_clear_pending_events();
2966         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
2967         match events[0] {
2968                 Event::PaymentFailed { ref payment_hash, .. } => {
2969                         assert_eq!(*payment_hash, fourth_payment_hash);
2970                 },
2971                 _ => panic!("Unexpected event"),
2972         }
2973         if !deliver_bs_raa {
2974                 match events[1] {
2975                         Event::PendingHTLCsForwardable { .. } => { },
2976                         _ => panic!("Unexpected event"),
2977                 };
2978         }
2979         nodes[1].node.process_pending_htlc_forwards();
2980         check_added_monitors!(nodes[1], 1);
2981
2982         let events = nodes[1].node.get_and_clear_pending_msg_events();
2983         assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
2984         match events[if deliver_bs_raa { 1 } else { 0 }] {
2985                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2986                 _ => panic!("Unexpected event"),
2987         }
2988         match events[if deliver_bs_raa { 2 } else { 1 }] {
2989                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
2990                         assert_eq!(channel_id, chan_2.2);
2991                         assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
2992                 },
2993                 _ => panic!("Unexpected event"),
2994         }
2995         if deliver_bs_raa {
2996                 match events[0] {
2997                         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, .. } } => {
2998                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
2999                                 assert_eq!(update_add_htlcs.len(), 1);
3000                                 assert!(update_fulfill_htlcs.is_empty());
3001                                 assert!(update_fail_htlcs.is_empty());
3002                                 assert!(update_fail_malformed_htlcs.is_empty());
3003                         },
3004                         _ => panic!("Unexpected event"),
3005                 }
3006         }
3007         match events[if deliver_bs_raa { 3 } else { 2 }] {
3008                 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, .. } } => {
3009                         assert!(update_add_htlcs.is_empty());
3010                         assert_eq!(update_fail_htlcs.len(), 3);
3011                         assert!(update_fulfill_htlcs.is_empty());
3012                         assert!(update_fail_malformed_htlcs.is_empty());
3013                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3014
3015                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3016                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3017                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3018
3019                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3020
3021                         let events = nodes[0].node.get_and_clear_pending_events();
3022                         assert_eq!(events.len(), 3);
3023                         match events[0] {
3024                                 Event::PaymentFailed { ref payment_hash, rejected_by_dest: _, ref network_update, .. } => {
3025                                         assert!(failed_htlcs.insert(payment_hash.0));
3026                                         // If we delivered B's RAA we got an unknown preimage error, not something
3027                                         // that we should update our routing table for.
3028                                         if !deliver_bs_raa {
3029                                                 assert!(network_update.is_some());
3030                                         }
3031                                 },
3032                                 _ => panic!("Unexpected event"),
3033                         }
3034                         match events[1] {
3035                                 Event::PaymentFailed { ref payment_hash, rejected_by_dest: _, ref network_update, .. } => {
3036                                         assert!(failed_htlcs.insert(payment_hash.0));
3037                                         assert!(network_update.is_some());
3038                                 },
3039                                 _ => panic!("Unexpected event"),
3040                         }
3041                         match events[2] {
3042                                 Event::PaymentFailed { ref payment_hash, rejected_by_dest: _, ref network_update, .. } => {
3043                                         assert!(failed_htlcs.insert(payment_hash.0));
3044                                         assert!(network_update.is_some());
3045                                 },
3046                                 _ => panic!("Unexpected event"),
3047                         }
3048                 },
3049                 _ => panic!("Unexpected event"),
3050         }
3051
3052         assert!(failed_htlcs.contains(&first_payment_hash.0));
3053         assert!(failed_htlcs.contains(&second_payment_hash.0));
3054         assert!(failed_htlcs.contains(&third_payment_hash.0));
3055 }
3056
3057 #[test]
3058 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3059         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3060         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3061         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3062         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3063 }
3064
3065 #[test]
3066 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3067         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3068         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3069         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3070         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3071 }
3072
3073 #[test]
3074 fn fail_backward_pending_htlc_upon_channel_failure() {
3075         let chanmon_cfgs = create_chanmon_cfgs(2);
3076         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3077         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3078         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3079         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3080         let logger = test_utils::TestLogger::new();
3081
3082         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3083         {
3084                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3085                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3086                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3087                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3088                 check_added_monitors!(nodes[0], 1);
3089
3090                 let payment_event = {
3091                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3092                         assert_eq!(events.len(), 1);
3093                         SendEvent::from_event(events.remove(0))
3094                 };
3095                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3096                 assert_eq!(payment_event.msgs.len(), 1);
3097         }
3098
3099         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3100         let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3101         {
3102                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3103                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3104                 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3105                 check_added_monitors!(nodes[0], 0);
3106
3107                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3108         }
3109
3110         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3111         {
3112                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3113
3114                 let secp_ctx = Secp256k1::new();
3115                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3116                 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3117                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3118                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3119                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height, &None).unwrap();
3120                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3121                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3122
3123                 // Send a 0-msat update_add_htlc to fail the channel.
3124                 let update_add_htlc = msgs::UpdateAddHTLC {
3125                         channel_id: chan.2,
3126                         htlc_id: 0,
3127                         amount_msat: 0,
3128                         payment_hash,
3129                         cltv_expiry,
3130                         onion_routing_packet,
3131                 };
3132                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3133         }
3134
3135         // Check that Alice fails backward the pending HTLC from the second payment.
3136         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3137         check_closed_broadcast!(nodes[0], true);
3138         check_added_monitors!(nodes[0], 1);
3139 }
3140
3141 #[test]
3142 fn test_htlc_ignore_latest_remote_commitment() {
3143         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3144         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3145         let chanmon_cfgs = create_chanmon_cfgs(2);
3146         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3147         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3148         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3149         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3150
3151         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3152         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3153         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3154         check_closed_broadcast!(nodes[0], true);
3155         check_added_monitors!(nodes[0], 1);
3156
3157         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3158         assert_eq!(node_txn.len(), 3);
3159         assert_eq!(node_txn[0], node_txn[1]);
3160
3161         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3162         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3163         check_closed_broadcast!(nodes[1], true);
3164         check_added_monitors!(nodes[1], 1);
3165
3166         // Duplicate the connect_block call since this may happen due to other listeners
3167         // registering new transactions
3168         header.prev_blockhash = header.block_hash();
3169         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3170 }
3171
3172 #[test]
3173 fn test_force_close_fail_back() {
3174         // Check which HTLCs are failed-backwards on channel force-closure
3175         let chanmon_cfgs = create_chanmon_cfgs(3);
3176         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3177         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3178         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3179         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3180         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3181         let logger = test_utils::TestLogger::new();
3182
3183         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3184
3185         let mut payment_event = {
3186                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3187                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, 42, &logger).unwrap();
3188                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3189                 check_added_monitors!(nodes[0], 1);
3190
3191                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3192                 assert_eq!(events.len(), 1);
3193                 SendEvent::from_event(events.remove(0))
3194         };
3195
3196         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3197         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3198
3199         expect_pending_htlcs_forwardable!(nodes[1]);
3200
3201         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3202         assert_eq!(events_2.len(), 1);
3203         payment_event = SendEvent::from_event(events_2.remove(0));
3204         assert_eq!(payment_event.msgs.len(), 1);
3205
3206         check_added_monitors!(nodes[1], 1);
3207         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3208         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3209         check_added_monitors!(nodes[2], 1);
3210         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3211
3212         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3213         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3214         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3215
3216         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3217         check_closed_broadcast!(nodes[2], true);
3218         check_added_monitors!(nodes[2], 1);
3219         let tx = {
3220                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3221                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3222                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3223                 // back to nodes[1] upon timeout otherwise.
3224                 assert_eq!(node_txn.len(), 1);
3225                 node_txn.remove(0)
3226         };
3227
3228         mine_transaction(&nodes[1], &tx);
3229
3230         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3231         check_closed_broadcast!(nodes[1], true);
3232         check_added_monitors!(nodes[1], 1);
3233
3234         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3235         {
3236                 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3237                 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3238                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3239         }
3240         mine_transaction(&nodes[2], &tx);
3241         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3242         assert_eq!(node_txn.len(), 1);
3243         assert_eq!(node_txn[0].input.len(), 1);
3244         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3245         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3246         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3247
3248         check_spends!(node_txn[0], tx);
3249 }
3250
3251 #[test]
3252 fn test_dup_events_on_peer_disconnect() {
3253         // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3254         // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3255         // as we used to generate the event immediately upon receipt of the payment preimage in the
3256         // update_fulfill_htlc message.
3257
3258         let chanmon_cfgs = create_chanmon_cfgs(2);
3259         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3260         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3261         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3262         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3263
3264         let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3265
3266         assert!(nodes[1].node.claim_funds(payment_preimage));
3267         check_added_monitors!(nodes[1], 1);
3268         let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3269         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3270         expect_payment_sent!(nodes[0], payment_preimage);
3271
3272         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3273         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3274
3275         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3276         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3277 }
3278
3279 #[test]
3280 fn test_simple_peer_disconnect() {
3281         // Test that we can reconnect when there are no lost messages
3282         let chanmon_cfgs = create_chanmon_cfgs(3);
3283         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3284         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3285         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3286         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3287         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3288
3289         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3290         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3291         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3292
3293         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3294         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3295         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3296         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3297
3298         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3299         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3300         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3301
3302         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3303         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3304         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3305         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
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         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3311         fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_hash_5);
3312
3313         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3314         {
3315                 let events = nodes[0].node.get_and_clear_pending_events();
3316                 assert_eq!(events.len(), 2);
3317                 match events[0] {
3318                         Event::PaymentSent { payment_preimage } => {
3319                                 assert_eq!(payment_preimage, payment_preimage_3);
3320                         },
3321                         _ => panic!("Unexpected event"),
3322                 }
3323                 match events[1] {
3324                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3325                                 assert_eq!(payment_hash, payment_hash_5);
3326                                 assert!(rejected_by_dest);
3327                         },
3328                         _ => panic!("Unexpected event"),
3329                 }
3330         }
3331
3332         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3333         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3334 }
3335
3336 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken_lnd: bool) {
3337         // Test that we can reconnect when in-flight HTLC updates get dropped
3338         let chanmon_cfgs = create_chanmon_cfgs(2);
3339         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3340         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3341         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3342
3343         let mut as_funding_locked = None;
3344         if messages_delivered == 0 {
3345                 let (funding_locked, _, _) = create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3346                 as_funding_locked = Some(funding_locked);
3347                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3348                 // Note that we store it so that if we're running with `simulate_broken_lnd` we can deliver
3349                 // it before the channel_reestablish message.
3350         } else {
3351                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3352         }
3353
3354         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3355
3356         let logger = test_utils::TestLogger::new();
3357         let payment_event = {
3358                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3359                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph,
3360                         &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3361                         &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3362                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3363                 check_added_monitors!(nodes[0], 1);
3364
3365                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3366                 assert_eq!(events.len(), 1);
3367                 SendEvent::from_event(events.remove(0))
3368         };
3369         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3370
3371         if messages_delivered < 2 {
3372                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3373         } else {
3374                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3375                 if messages_delivered >= 3 {
3376                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3377                         check_added_monitors!(nodes[1], 1);
3378                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3379
3380                         if messages_delivered >= 4 {
3381                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3382                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3383                                 check_added_monitors!(nodes[0], 1);
3384
3385                                 if messages_delivered >= 5 {
3386                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3387                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3388                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3389                                         check_added_monitors!(nodes[0], 1);
3390
3391                                         if messages_delivered >= 6 {
3392                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3393                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3394                                                 check_added_monitors!(nodes[1], 1);
3395                                         }
3396                                 }
3397                         }
3398                 }
3399         }
3400
3401         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3402         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3403         if messages_delivered < 3 {
3404                 if simulate_broken_lnd {
3405                         // lnd has a long-standing bug where they send a funding_locked prior to a
3406                         // channel_reestablish if you reconnect prior to funding_locked time.
3407                         //
3408                         // Here we simulate that behavior, delivering a funding_locked immediately on
3409                         // reconnect. Note that we don't bother skipping the now-duplicate funding_locked sent
3410                         // in `reconnect_nodes` but we currently don't fail based on that.
3411                         //
3412                         // See-also <https://github.com/lightningnetwork/lnd/issues/4006>
3413                         nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding_locked.as_ref().unwrap().0);
3414                 }
3415                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3416                 // received on either side, both sides will need to resend them.
3417                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3418         } else if messages_delivered == 3 {
3419                 // nodes[0] still wants its RAA + commitment_signed
3420                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3421         } else if messages_delivered == 4 {
3422                 // nodes[0] still wants its commitment_signed
3423                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3424         } else if messages_delivered == 5 {
3425                 // nodes[1] still wants its final RAA
3426                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3427         } else if messages_delivered == 6 {
3428                 // Everything was delivered...
3429                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3430         }
3431
3432         let events_1 = nodes[1].node.get_and_clear_pending_events();
3433         assert_eq!(events_1.len(), 1);
3434         match events_1[0] {
3435                 Event::PendingHTLCsForwardable { .. } => { },
3436                 _ => panic!("Unexpected event"),
3437         };
3438
3439         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3440         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3441         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3442
3443         nodes[1].node.process_pending_htlc_forwards();
3444
3445         let events_2 = nodes[1].node.get_and_clear_pending_events();
3446         assert_eq!(events_2.len(), 1);
3447         match events_2[0] {
3448                 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
3449                         assert_eq!(payment_hash_1, *payment_hash);
3450                         assert_eq!(amt, 1000000);
3451                         match &purpose {
3452                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3453                                         assert!(payment_preimage.is_none());
3454                                         assert_eq!(payment_secret_1, *payment_secret);
3455                                 },
3456                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
3457                         }
3458                 },
3459                 _ => panic!("Unexpected event"),
3460         }
3461
3462         nodes[1].node.claim_funds(payment_preimage_1);
3463         check_added_monitors!(nodes[1], 1);
3464
3465         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3466         assert_eq!(events_3.len(), 1);
3467         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3468                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3469                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3470                         assert!(updates.update_add_htlcs.is_empty());
3471                         assert!(updates.update_fail_htlcs.is_empty());
3472                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3473                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3474                         assert!(updates.update_fee.is_none());
3475                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3476                 },
3477                 _ => panic!("Unexpected event"),
3478         };
3479
3480         if messages_delivered >= 1 {
3481                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3482
3483                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3484                 assert_eq!(events_4.len(), 1);
3485                 match events_4[0] {
3486                         Event::PaymentSent { ref payment_preimage } => {
3487                                 assert_eq!(payment_preimage_1, *payment_preimage);
3488                         },
3489                         _ => panic!("Unexpected event"),
3490                 }
3491
3492                 if messages_delivered >= 2 {
3493                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3494                         check_added_monitors!(nodes[0], 1);
3495                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3496
3497                         if messages_delivered >= 3 {
3498                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3499                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3500                                 check_added_monitors!(nodes[1], 1);
3501
3502                                 if messages_delivered >= 4 {
3503                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3504                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3505                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3506                                         check_added_monitors!(nodes[1], 1);
3507
3508                                         if messages_delivered >= 5 {
3509                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3510                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3511                                                 check_added_monitors!(nodes[0], 1);
3512                                         }
3513                                 }
3514                         }
3515                 }
3516         }
3517
3518         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3519         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3520         if messages_delivered < 2 {
3521                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3522                 if messages_delivered < 1 {
3523                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3524                         assert_eq!(events_4.len(), 1);
3525                         match events_4[0] {
3526                                 Event::PaymentSent { ref payment_preimage } => {
3527                                         assert_eq!(payment_preimage_1, *payment_preimage);
3528                                 },
3529                                 _ => panic!("Unexpected event"),
3530                         }
3531                 } else {
3532                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3533                 }
3534         } else if messages_delivered == 2 {
3535                 // nodes[0] still wants its RAA + commitment_signed
3536                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3537         } else if messages_delivered == 3 {
3538                 // nodes[0] still wants its commitment_signed
3539                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3540         } else if messages_delivered == 4 {
3541                 // nodes[1] still wants its final RAA
3542                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3543         } else if messages_delivered == 5 {
3544                 // Everything was delivered...
3545                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3546         }
3547
3548         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3549         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3550         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3551
3552         // Channel should still work fine...
3553         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3554         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph,
3555                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3556                 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3557         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3558         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3559 }
3560
3561 #[test]
3562 fn test_drop_messages_peer_disconnect_a() {
3563         do_test_drop_messages_peer_disconnect(0, true);
3564         do_test_drop_messages_peer_disconnect(0, false);
3565         do_test_drop_messages_peer_disconnect(1, false);
3566         do_test_drop_messages_peer_disconnect(2, false);
3567 }
3568
3569 #[test]
3570 fn test_drop_messages_peer_disconnect_b() {
3571         do_test_drop_messages_peer_disconnect(3, false);
3572         do_test_drop_messages_peer_disconnect(4, false);
3573         do_test_drop_messages_peer_disconnect(5, false);
3574         do_test_drop_messages_peer_disconnect(6, false);
3575 }
3576
3577 #[test]
3578 fn test_funding_peer_disconnect() {
3579         // Test that we can lock in our funding tx while disconnected
3580         let chanmon_cfgs = create_chanmon_cfgs(2);
3581         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3582         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3583         let persister: test_utils::TestPersister;
3584         let new_chain_monitor: test_utils::TestChainMonitor;
3585         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3586         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3587         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3588
3589         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3590         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3591
3592         confirm_transaction(&nodes[0], &tx);
3593         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3594         assert_eq!(events_1.len(), 1);
3595         match events_1[0] {
3596                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3597                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3598                 },
3599                 _ => panic!("Unexpected event"),
3600         }
3601
3602         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3603
3604         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3605         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3606
3607         confirm_transaction(&nodes[1], &tx);
3608         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3609         assert_eq!(events_2.len(), 2);
3610         let funding_locked = match events_2[0] {
3611                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3612                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3613                         msg.clone()
3614                 },
3615                 _ => panic!("Unexpected event"),
3616         };
3617         let bs_announcement_sigs = match events_2[1] {
3618                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3619                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3620                         msg.clone()
3621                 },
3622                 _ => panic!("Unexpected event"),
3623         };
3624
3625         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3626
3627         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3628         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3629         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3630         assert_eq!(events_3.len(), 2);
3631         let as_announcement_sigs = match events_3[0] {
3632                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3633                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3634                         msg.clone()
3635                 },
3636                 _ => panic!("Unexpected event"),
3637         };
3638         let (as_announcement, as_update) = match events_3[1] {
3639                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3640                         (msg.clone(), update_msg.clone())
3641                 },
3642                 _ => panic!("Unexpected event"),
3643         };
3644
3645         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3646         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3647         assert_eq!(events_4.len(), 1);
3648         let (_, bs_update) = match events_4[0] {
3649                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3650                         (msg.clone(), update_msg.clone())
3651                 },
3652                 _ => panic!("Unexpected event"),
3653         };
3654
3655         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3656         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3657         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3658
3659         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3660         let logger = test_utils::TestLogger::new();
3661         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3662         let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3663         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3664
3665         // Check that after deserialization and reconnection we can still generate an identical
3666         // channel_announcement from the cached signatures.
3667         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3668
3669         let nodes_0_serialized = nodes[0].node.encode();
3670         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3671         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3672
3673         persister = test_utils::TestPersister::new();
3674         let keys_manager = &chanmon_cfgs[0].keys_manager;
3675         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);
3676         nodes[0].chain_monitor = &new_chain_monitor;
3677         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3678         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3679                 &mut chan_0_monitor_read, keys_manager).unwrap();
3680         assert!(chan_0_monitor_read.is_empty());
3681
3682         let mut nodes_0_read = &nodes_0_serialized[..];
3683         let (_, nodes_0_deserialized_tmp) = {
3684                 let mut channel_monitors = HashMap::new();
3685                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3686                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3687                         default_config: UserConfig::default(),
3688                         keys_manager,
3689                         fee_estimator: node_cfgs[0].fee_estimator,
3690                         chain_monitor: nodes[0].chain_monitor,
3691                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3692                         logger: nodes[0].logger,
3693                         channel_monitors,
3694                 }).unwrap()
3695         };
3696         nodes_0_deserialized = nodes_0_deserialized_tmp;
3697         assert!(nodes_0_read.is_empty());
3698
3699         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
3700         nodes[0].node = &nodes_0_deserialized;
3701         check_added_monitors!(nodes[0], 1);
3702
3703         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3704
3705         // as_announcement should be re-generated exactly by broadcast_node_announcement.
3706         nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
3707         let msgs = nodes[0].node.get_and_clear_pending_msg_events();
3708         let mut found_announcement = false;
3709         for event in msgs.iter() {
3710                 match event {
3711                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
3712                                 if *msg == as_announcement { found_announcement = true; }
3713                         },
3714                         MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
3715                         _ => panic!("Unexpected event"),
3716                 }
3717         }
3718         assert!(found_announcement);
3719 }
3720
3721 #[test]
3722 fn test_drop_messages_peer_disconnect_dual_htlc() {
3723         // Test that we can handle reconnecting when both sides of a channel have pending
3724         // commitment_updates when we disconnect.
3725         let chanmon_cfgs = create_chanmon_cfgs(2);
3726         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3727         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3728         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3729         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3730         let logger = test_utils::TestLogger::new();
3731
3732         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3733
3734         // Now try to send a second payment which will fail to send
3735         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
3736         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3737         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3738         nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
3739         check_added_monitors!(nodes[0], 1);
3740
3741         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3742         assert_eq!(events_1.len(), 1);
3743         match events_1[0] {
3744                 MessageSendEvent::UpdateHTLCs { .. } => {},
3745                 _ => panic!("Unexpected event"),
3746         }
3747
3748         assert!(nodes[1].node.claim_funds(payment_preimage_1));
3749         check_added_monitors!(nodes[1], 1);
3750
3751         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3752         assert_eq!(events_2.len(), 1);
3753         match events_2[0] {
3754                 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 } } => {
3755                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3756                         assert!(update_add_htlcs.is_empty());
3757                         assert_eq!(update_fulfill_htlcs.len(), 1);
3758                         assert!(update_fail_htlcs.is_empty());
3759                         assert!(update_fail_malformed_htlcs.is_empty());
3760                         assert!(update_fee.is_none());
3761
3762                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3763                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3764                         assert_eq!(events_3.len(), 1);
3765                         match events_3[0] {
3766                                 Event::PaymentSent { ref payment_preimage } => {
3767                                         assert_eq!(*payment_preimage, payment_preimage_1);
3768                                 },
3769                                 _ => panic!("Unexpected event"),
3770                         }
3771
3772                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3773                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3774                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3775                         check_added_monitors!(nodes[0], 1);
3776                 },
3777                 _ => panic!("Unexpected event"),
3778         }
3779
3780         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3781         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3782
3783         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3784         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3785         assert_eq!(reestablish_1.len(), 1);
3786         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3787         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3788         assert_eq!(reestablish_2.len(), 1);
3789
3790         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3791         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3792         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3793         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3794
3795         assert!(as_resp.0.is_none());
3796         assert!(bs_resp.0.is_none());
3797
3798         assert!(bs_resp.1.is_none());
3799         assert!(bs_resp.2.is_none());
3800
3801         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3802
3803         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3804         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3805         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3806         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3807         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3808         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3809         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3810         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3811         // No commitment_signed so get_event_msg's assert(len == 1) passes
3812         check_added_monitors!(nodes[1], 1);
3813
3814         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3815         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3816         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3817         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3818         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3819         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3820         assert!(bs_second_commitment_signed.update_fee.is_none());
3821         check_added_monitors!(nodes[1], 1);
3822
3823         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3824         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3825         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3826         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3827         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3828         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3829         assert!(as_commitment_signed.update_fee.is_none());
3830         check_added_monitors!(nodes[0], 1);
3831
3832         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3833         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3834         // No commitment_signed so get_event_msg's assert(len == 1) passes
3835         check_added_monitors!(nodes[0], 1);
3836
3837         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3838         let bs_second_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_revoke_and_ack);
3843         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3844         check_added_monitors!(nodes[1], 1);
3845
3846         expect_pending_htlcs_forwardable!(nodes[1]);
3847
3848         let events_5 = nodes[1].node.get_and_clear_pending_events();
3849         assert_eq!(events_5.len(), 1);
3850         match events_5[0] {
3851                 Event::PaymentReceived { ref payment_hash, ref purpose, .. } => {
3852                         assert_eq!(payment_hash_2, *payment_hash);
3853                         match &purpose {
3854                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3855                                         assert!(payment_preimage.is_none());
3856                                         assert_eq!(payment_secret_2, *payment_secret);
3857                                 },
3858                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
3859                         }
3860                 },
3861                 _ => panic!("Unexpected event"),
3862         }
3863
3864         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3865         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3866         check_added_monitors!(nodes[0], 1);
3867
3868         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3869 }
3870
3871 fn do_test_htlc_timeout(send_partial_mpp: bool) {
3872         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
3873         // to avoid our counterparty failing the channel.
3874         let chanmon_cfgs = create_chanmon_cfgs(2);
3875         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3876         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3877         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3878
3879         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3880         let logger = test_utils::TestLogger::new();
3881
3882         let our_payment_hash = if send_partial_mpp {
3883                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3884                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
3885                 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
3886                 // Use the utility function send_payment_along_path to send the payment with MPP data which
3887                 // indicates there are more HTLCs coming.
3888                 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.
3889                 let mpp_id = MppId([42; 32]);
3890                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height, mpp_id, &None).unwrap();
3891                 check_added_monitors!(nodes[0], 1);
3892                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3893                 assert_eq!(events.len(), 1);
3894                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
3895                 // hop should *not* yet generate any PaymentReceived event(s).
3896                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
3897                 our_payment_hash
3898         } else {
3899                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
3900         };
3901
3902         let mut block = Block {
3903                 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
3904                 txdata: vec![],
3905         };
3906         connect_block(&nodes[0], &block);
3907         connect_block(&nodes[1], &block);
3908         let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
3909         for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
3910                 block.header.prev_blockhash = block.block_hash();
3911                 connect_block(&nodes[0], &block);
3912                 connect_block(&nodes[1], &block);
3913         }
3914
3915         expect_pending_htlcs_forwardable!(nodes[1]);
3916
3917         check_added_monitors!(nodes[1], 1);
3918         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3919         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
3920         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
3921         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
3922         assert!(htlc_timeout_updates.update_fee.is_none());
3923
3924         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
3925         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
3926         // 100_000 msat as u64, followed by the height at which we failed back above
3927         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
3928         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
3929         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
3930 }
3931
3932 #[test]
3933 fn test_htlc_timeout() {
3934         do_test_htlc_timeout(true);
3935         do_test_htlc_timeout(false);
3936 }
3937
3938 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
3939         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
3940         let chanmon_cfgs = create_chanmon_cfgs(3);
3941         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3942         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3943         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3944         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3945         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3946
3947         // Make sure all nodes are at the same starting height
3948         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
3949         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
3950         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
3951
3952         let logger = test_utils::TestLogger::new();
3953
3954         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
3955         let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3956         {
3957                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3958                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
3959                 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
3960         }
3961         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
3962         check_added_monitors!(nodes[1], 1);
3963
3964         // Now attempt to route a second payment, which should be placed in the holding cell
3965         let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3966         if forwarded_htlc {
3967                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3968                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
3969                 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
3970                 check_added_monitors!(nodes[0], 1);
3971                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
3972                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3973                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3974                 expect_pending_htlcs_forwardable!(nodes[1]);
3975                 check_added_monitors!(nodes[1], 0);
3976         } else {
3977                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3978                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
3979                 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
3980                 check_added_monitors!(nodes[1], 0);
3981         }
3982
3983         connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
3984         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3985         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3986         connect_blocks(&nodes[1], 1);
3987
3988         if forwarded_htlc {
3989                 expect_pending_htlcs_forwardable!(nodes[1]);
3990                 check_added_monitors!(nodes[1], 1);
3991                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
3992                 assert_eq!(fail_commit.len(), 1);
3993                 match fail_commit[0] {
3994                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
3995                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3996                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
3997                         },
3998                         _ => unreachable!(),
3999                 }
4000                 expect_payment_failed_with_update!(nodes[0], second_payment_hash, false, chan_2.0.contents.short_channel_id, false);
4001         } else {
4002                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4003         }
4004 }
4005
4006 #[test]
4007 fn test_holding_cell_htlc_add_timeouts() {
4008         do_test_holding_cell_htlc_add_timeouts(false);
4009         do_test_holding_cell_htlc_add_timeouts(true);
4010 }
4011
4012 #[test]
4013 fn test_no_txn_manager_serialize_deserialize() {
4014         let chanmon_cfgs = create_chanmon_cfgs(2);
4015         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4016         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4017         let logger: test_utils::TestLogger;
4018         let fee_estimator: test_utils::TestFeeEstimator;
4019         let persister: test_utils::TestPersister;
4020         let new_chain_monitor: test_utils::TestChainMonitor;
4021         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4022         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4023
4024         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4025
4026         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4027
4028         let nodes_0_serialized = nodes[0].node.encode();
4029         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4030         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4031
4032         logger = test_utils::TestLogger::new();
4033         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4034         persister = test_utils::TestPersister::new();
4035         let keys_manager = &chanmon_cfgs[0].keys_manager;
4036         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4037         nodes[0].chain_monitor = &new_chain_monitor;
4038         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4039         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4040                 &mut chan_0_monitor_read, keys_manager).unwrap();
4041         assert!(chan_0_monitor_read.is_empty());
4042
4043         let mut nodes_0_read = &nodes_0_serialized[..];
4044         let config = UserConfig::default();
4045         let (_, nodes_0_deserialized_tmp) = {
4046                 let mut channel_monitors = HashMap::new();
4047                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4048                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4049                         default_config: config,
4050                         keys_manager,
4051                         fee_estimator: &fee_estimator,
4052                         chain_monitor: nodes[0].chain_monitor,
4053                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4054                         logger: &logger,
4055                         channel_monitors,
4056                 }).unwrap()
4057         };
4058         nodes_0_deserialized = nodes_0_deserialized_tmp;
4059         assert!(nodes_0_read.is_empty());
4060
4061         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4062         nodes[0].node = &nodes_0_deserialized;
4063         assert_eq!(nodes[0].node.list_channels().len(), 1);
4064         check_added_monitors!(nodes[0], 1);
4065
4066         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4067         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4068         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4069         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4070
4071         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4072         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4073         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4074         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4075
4076         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4077         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4078         for node in nodes.iter() {
4079                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4080                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4081                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4082         }
4083
4084         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4085 }
4086
4087 #[test]
4088 fn mpp_failure() {
4089         let chanmon_cfgs = create_chanmon_cfgs(4);
4090         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4091         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4092         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4093
4094         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4095         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4096         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4097         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4098         let logger = test_utils::TestLogger::new();
4099
4100         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
4101         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4102         let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
4103         let path = route.paths[0].clone();
4104         route.paths.push(path);
4105         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
4106         route.paths[0][0].short_channel_id = chan_1_id;
4107         route.paths[0][1].short_channel_id = chan_3_id;
4108         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
4109         route.paths[1][0].short_channel_id = chan_2_id;
4110         route.paths[1][1].short_channel_id = chan_4_id;
4111         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
4112         fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash);
4113 }
4114
4115 #[test]
4116 fn test_dup_htlc_onchain_fails_on_reload() {
4117         // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4118         // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4119         // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4120         // the ChannelMonitor tells it to.
4121         //
4122         // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4123         // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4124         // PaymentFailed event appearing). However, because we may not serialize the relevant
4125         // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4126         // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4127         // and de-duplicates ChannelMonitor events.
4128         //
4129         // This tests that explicit tracking behavior.
4130         let chanmon_cfgs = create_chanmon_cfgs(2);
4131         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4132         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4133         let persister: test_utils::TestPersister;
4134         let new_chain_monitor: test_utils::TestChainMonitor;
4135         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4136         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4137
4138         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4139
4140         // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4141         // nodes[0].
4142         let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4143         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4144         check_closed_broadcast!(nodes[0], true);
4145         check_added_monitors!(nodes[0], 1);
4146
4147         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4148         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4149
4150         // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
4151         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
4152         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4153         assert_eq!(node_txn.len(), 3);
4154         assert_eq!(node_txn[0], node_txn[1]);
4155
4156         assert!(nodes[1].node.claim_funds(payment_preimage));
4157         check_added_monitors!(nodes[1], 1);
4158
4159         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4160         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4161         check_closed_broadcast!(nodes[1], true);
4162         check_added_monitors!(nodes[1], 1);
4163         let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4164
4165         header.prev_blockhash = nodes[0].best_block_hash();
4166         connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4167
4168         // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4169         // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4170         // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4171         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4172         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4173
4174         header.prev_blockhash = nodes[0].best_block_hash();
4175         let claim_block = Block { header, txdata: claim_txn};
4176         connect_block(&nodes[0], &claim_block);
4177         expect_payment_sent!(nodes[0], payment_preimage);
4178
4179         // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4180         // connected a highly-relevant block, it likely gets serialized out now.
4181         let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4182         nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4183
4184         // Now reload nodes[0]...
4185         persister = test_utils::TestPersister::new();
4186         let keys_manager = &chanmon_cfgs[0].keys_manager;
4187         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);
4188         nodes[0].chain_monitor = &new_chain_monitor;
4189         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4190         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4191                 &mut chan_0_monitor_read, keys_manager).unwrap();
4192         assert!(chan_0_monitor_read.is_empty());
4193
4194         let (_, nodes_0_deserialized_tmp) = {
4195                 let mut channel_monitors = HashMap::new();
4196                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4197                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4198                         ::read(&mut io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4199                                 default_config: Default::default(),
4200                                 keys_manager,
4201                                 fee_estimator: node_cfgs[0].fee_estimator,
4202                                 chain_monitor: nodes[0].chain_monitor,
4203                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4204                                 logger: nodes[0].logger,
4205                                 channel_monitors,
4206                         }).unwrap()
4207         };
4208         nodes_0_deserialized = nodes_0_deserialized_tmp;
4209
4210         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4211         check_added_monitors!(nodes[0], 1);
4212         nodes[0].node = &nodes_0_deserialized;
4213
4214         // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4215         // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4216         // payment events should kick in, leaving us with no pending events here.
4217         let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
4218         nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
4219         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4220 }
4221
4222 #[test]
4223 fn test_manager_serialize_deserialize_events() {
4224         // This test makes sure the events field in ChannelManager survives de/serialization
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 fee_estimator: test_utils::TestFeeEstimator;
4229         let persister: test_utils::TestPersister;
4230         let logger: test_utils::TestLogger;
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
4235         // Start creating a channel, but stop right before broadcasting the funding transaction
4236         let channel_value = 100000;
4237         let push_msat = 10001;
4238         let a_flags = InitFeatures::known();
4239         let b_flags = InitFeatures::known();
4240         let node_a = nodes.remove(0);
4241         let node_b = nodes.remove(0);
4242         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4243         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()));
4244         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()));
4245
4246         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4247
4248         node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4249         check_added_monitors!(node_a, 0);
4250
4251         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()));
4252         {
4253                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4254                 assert_eq!(added_monitors.len(), 1);
4255                 assert_eq!(added_monitors[0].0, funding_output);
4256                 added_monitors.clear();
4257         }
4258
4259         node_a.node.handle_funding_signed(&node_b.node.get_our_node_id(), &get_event_msg!(node_b, MessageSendEvent::SendFundingSigned, node_a.node.get_our_node_id()));
4260         {
4261                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4262                 assert_eq!(added_monitors.len(), 1);
4263                 assert_eq!(added_monitors[0].0, funding_output);
4264                 added_monitors.clear();
4265         }
4266         // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4267
4268         nodes.push(node_a);
4269         nodes.push(node_b);
4270
4271         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4272         let nodes_0_serialized = nodes[0].node.encode();
4273         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4274         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4275
4276         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4277         logger = test_utils::TestLogger::new();
4278         persister = test_utils::TestPersister::new();
4279         let keys_manager = &chanmon_cfgs[0].keys_manager;
4280         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4281         nodes[0].chain_monitor = &new_chain_monitor;
4282         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4283         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4284                 &mut chan_0_monitor_read, keys_manager).unwrap();
4285         assert!(chan_0_monitor_read.is_empty());
4286
4287         let mut nodes_0_read = &nodes_0_serialized[..];
4288         let config = UserConfig::default();
4289         let (_, nodes_0_deserialized_tmp) = {
4290                 let mut channel_monitors = HashMap::new();
4291                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4292                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4293                         default_config: config,
4294                         keys_manager,
4295                         fee_estimator: &fee_estimator,
4296                         chain_monitor: nodes[0].chain_monitor,
4297                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4298                         logger: &logger,
4299                         channel_monitors,
4300                 }).unwrap()
4301         };
4302         nodes_0_deserialized = nodes_0_deserialized_tmp;
4303         assert!(nodes_0_read.is_empty());
4304
4305         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4306
4307         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4308         nodes[0].node = &nodes_0_deserialized;
4309
4310         // After deserializing, make sure the funding_transaction is still held by the channel manager
4311         let events_4 = nodes[0].node.get_and_clear_pending_events();
4312         assert_eq!(events_4.len(), 0);
4313         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4314         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4315
4316         // Make sure the channel is functioning as though the de/serialization never happened
4317         assert_eq!(nodes[0].node.list_channels().len(), 1);
4318         check_added_monitors!(nodes[0], 1);
4319
4320         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4321         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4322         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4323         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4324
4325         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4326         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4327         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4328         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4329
4330         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4331         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4332         for node in nodes.iter() {
4333                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4334                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4335                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4336         }
4337
4338         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4339 }
4340
4341 #[test]
4342 fn test_simple_manager_serialize_deserialize() {
4343         let chanmon_cfgs = create_chanmon_cfgs(2);
4344         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4345         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4346         let logger: test_utils::TestLogger;
4347         let fee_estimator: test_utils::TestFeeEstimator;
4348         let persister: test_utils::TestPersister;
4349         let new_chain_monitor: test_utils::TestChainMonitor;
4350         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4351         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4352         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4353
4354         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4355         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4356
4357         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4358
4359         let nodes_0_serialized = nodes[0].node.encode();
4360         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4361         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4362
4363         logger = test_utils::TestLogger::new();
4364         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4365         persister = test_utils::TestPersister::new();
4366         let keys_manager = &chanmon_cfgs[0].keys_manager;
4367         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4368         nodes[0].chain_monitor = &new_chain_monitor;
4369         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4370         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4371                 &mut chan_0_monitor_read, keys_manager).unwrap();
4372         assert!(chan_0_monitor_read.is_empty());
4373
4374         let mut nodes_0_read = &nodes_0_serialized[..];
4375         let (_, nodes_0_deserialized_tmp) = {
4376                 let mut channel_monitors = HashMap::new();
4377                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4378                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4379                         default_config: UserConfig::default(),
4380                         keys_manager,
4381                         fee_estimator: &fee_estimator,
4382                         chain_monitor: nodes[0].chain_monitor,
4383                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4384                         logger: &logger,
4385                         channel_monitors,
4386                 }).unwrap()
4387         };
4388         nodes_0_deserialized = nodes_0_deserialized_tmp;
4389         assert!(nodes_0_read.is_empty());
4390
4391         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4392         nodes[0].node = &nodes_0_deserialized;
4393         check_added_monitors!(nodes[0], 1);
4394
4395         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4396
4397         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4398         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4399 }
4400
4401 #[test]
4402 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4403         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4404         let chanmon_cfgs = create_chanmon_cfgs(4);
4405         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4406         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4407         let logger: test_utils::TestLogger;
4408         let fee_estimator: test_utils::TestFeeEstimator;
4409         let persister: test_utils::TestPersister;
4410         let new_chain_monitor: test_utils::TestChainMonitor;
4411         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4412         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4413         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4414         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4415         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4416
4417         let mut node_0_stale_monitors_serialized = Vec::new();
4418         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4419                 let mut writer = test_utils::TestVecWriter(Vec::new());
4420                 monitor.1.write(&mut writer).unwrap();
4421                 node_0_stale_monitors_serialized.push(writer.0);
4422         }
4423
4424         let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4425
4426         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4427         let nodes_0_serialized = nodes[0].node.encode();
4428
4429         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4430         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4431         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4432         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4433
4434         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4435         // nodes[3])
4436         let mut node_0_monitors_serialized = Vec::new();
4437         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4438                 let mut writer = test_utils::TestVecWriter(Vec::new());
4439                 monitor.1.write(&mut writer).unwrap();
4440                 node_0_monitors_serialized.push(writer.0);
4441         }
4442
4443         logger = test_utils::TestLogger::new();
4444         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4445         persister = test_utils::TestPersister::new();
4446         let keys_manager = &chanmon_cfgs[0].keys_manager;
4447         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4448         nodes[0].chain_monitor = &new_chain_monitor;
4449
4450
4451         let mut node_0_stale_monitors = Vec::new();
4452         for serialized in node_0_stale_monitors_serialized.iter() {
4453                 let mut read = &serialized[..];
4454                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4455                 assert!(read.is_empty());
4456                 node_0_stale_monitors.push(monitor);
4457         }
4458
4459         let mut node_0_monitors = Vec::new();
4460         for serialized in node_0_monitors_serialized.iter() {
4461                 let mut read = &serialized[..];
4462                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4463                 assert!(read.is_empty());
4464                 node_0_monitors.push(monitor);
4465         }
4466
4467         let mut nodes_0_read = &nodes_0_serialized[..];
4468         if let Err(msgs::DecodeError::InvalidValue) =
4469                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4470                 default_config: UserConfig::default(),
4471                 keys_manager,
4472                 fee_estimator: &fee_estimator,
4473                 chain_monitor: nodes[0].chain_monitor,
4474                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4475                 logger: &logger,
4476                 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4477         }) { } else {
4478                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4479         };
4480
4481         let mut nodes_0_read = &nodes_0_serialized[..];
4482         let (_, nodes_0_deserialized_tmp) =
4483                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4484                 default_config: UserConfig::default(),
4485                 keys_manager,
4486                 fee_estimator: &fee_estimator,
4487                 chain_monitor: nodes[0].chain_monitor,
4488                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4489                 logger: &logger,
4490                 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4491         }).unwrap();
4492         nodes_0_deserialized = nodes_0_deserialized_tmp;
4493         assert!(nodes_0_read.is_empty());
4494
4495         { // Channel close should result in a commitment tx
4496                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4497                 assert_eq!(txn.len(), 1);
4498                 check_spends!(txn[0], funding_tx);
4499                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4500         }
4501
4502         for monitor in node_0_monitors.drain(..) {
4503                 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4504                 check_added_monitors!(nodes[0], 1);
4505         }
4506         nodes[0].node = &nodes_0_deserialized;
4507
4508         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4509         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4510         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4511         //... and we can even still claim the payment!
4512         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4513
4514         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4515         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4516         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4517         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4518         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4519         assert_eq!(msg_events.len(), 1);
4520         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4521                 match action {
4522                         &ErrorAction::SendErrorMessage { ref msg } => {
4523                                 assert_eq!(msg.channel_id, channel_id);
4524                         },
4525                         _ => panic!("Unexpected event!"),
4526                 }
4527         }
4528 }
4529
4530 macro_rules! check_spendable_outputs {
4531         ($node: expr, $keysinterface: expr) => {
4532                 {
4533                         let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4534                         let mut txn = Vec::new();
4535                         let mut all_outputs = Vec::new();
4536                         let secp_ctx = Secp256k1::new();
4537                         for event in events.drain(..) {
4538                                 match event {
4539                                         Event::SpendableOutputs { mut outputs } => {
4540                                                 for outp in outputs.drain(..) {
4541                                                         txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4542                                                         all_outputs.push(outp);
4543                                                 }
4544                                         },
4545                                         _ => panic!("Unexpected event"),
4546                                 };
4547                         }
4548                         if all_outputs.len() > 1 {
4549                                 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) {
4550                                         txn.push(tx);
4551                                 }
4552                         }
4553                         txn
4554                 }
4555         }
4556 }
4557
4558 #[test]
4559 fn test_claim_sizeable_push_msat() {
4560         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4561         let chanmon_cfgs = create_chanmon_cfgs(2);
4562         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4563         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4564         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4565
4566         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4567         nodes[1].node.force_close_channel(&chan.2).unwrap();
4568         check_closed_broadcast!(nodes[1], true);
4569         check_added_monitors!(nodes[1], 1);
4570         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4571         assert_eq!(node_txn.len(), 1);
4572         check_spends!(node_txn[0], chan.3);
4573         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
4574
4575         mine_transaction(&nodes[1], &node_txn[0]);
4576         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4577
4578         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4579         assert_eq!(spend_txn.len(), 1);
4580         assert_eq!(spend_txn[0].input.len(), 1);
4581         check_spends!(spend_txn[0], node_txn[0]);
4582         assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
4583 }
4584
4585 #[test]
4586 fn test_claim_on_remote_sizeable_push_msat() {
4587         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4588         // to_remote output is encumbered by a P2WPKH
4589         let chanmon_cfgs = create_chanmon_cfgs(2);
4590         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4591         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4592         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4593
4594         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4595         nodes[0].node.force_close_channel(&chan.2).unwrap();
4596         check_closed_broadcast!(nodes[0], true);
4597         check_added_monitors!(nodes[0], 1);
4598
4599         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4600         assert_eq!(node_txn.len(), 1);
4601         check_spends!(node_txn[0], chan.3);
4602         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
4603
4604         mine_transaction(&nodes[1], &node_txn[0]);
4605         check_closed_broadcast!(nodes[1], true);
4606         check_added_monitors!(nodes[1], 1);
4607         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4608
4609         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4610         assert_eq!(spend_txn.len(), 1);
4611         check_spends!(spend_txn[0], node_txn[0]);
4612 }
4613
4614 #[test]
4615 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4616         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4617         // to_remote output is encumbered by a P2WPKH
4618
4619         let chanmon_cfgs = create_chanmon_cfgs(2);
4620         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4621         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4622         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4623
4624         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4625         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4626         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4627         assert_eq!(revoked_local_txn[0].input.len(), 1);
4628         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4629
4630         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4631         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4632         check_closed_broadcast!(nodes[1], true);
4633         check_added_monitors!(nodes[1], 1);
4634
4635         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4636         mine_transaction(&nodes[1], &node_txn[0]);
4637         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4638
4639         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4640         assert_eq!(spend_txn.len(), 3);
4641         check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4642         check_spends!(spend_txn[1], node_txn[0]);
4643         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4644 }
4645
4646 #[test]
4647 fn test_static_spendable_outputs_preimage_tx() {
4648         let chanmon_cfgs = create_chanmon_cfgs(2);
4649         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4650         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4651         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4652
4653         // Create some initial channels
4654         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4655
4656         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4657
4658         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4659         assert_eq!(commitment_tx[0].input.len(), 1);
4660         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4661
4662         // Settle A's commitment tx on B's chain
4663         assert!(nodes[1].node.claim_funds(payment_preimage));
4664         check_added_monitors!(nodes[1], 1);
4665         mine_transaction(&nodes[1], &commitment_tx[0]);
4666         check_added_monitors!(nodes[1], 1);
4667         let events = nodes[1].node.get_and_clear_pending_msg_events();
4668         match events[0] {
4669                 MessageSendEvent::UpdateHTLCs { .. } => {},
4670                 _ => panic!("Unexpected event"),
4671         }
4672         match events[1] {
4673                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4674                 _ => panic!("Unexepected event"),
4675         }
4676
4677         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4678         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4679         assert_eq!(node_txn.len(), 3);
4680         check_spends!(node_txn[0], commitment_tx[0]);
4681         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4682         check_spends!(node_txn[1], chan_1.3);
4683         check_spends!(node_txn[2], node_txn[1]);
4684
4685         mine_transaction(&nodes[1], &node_txn[0]);
4686         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4687
4688         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4689         assert_eq!(spend_txn.len(), 1);
4690         check_spends!(spend_txn[0], node_txn[0]);
4691 }
4692
4693 #[test]
4694 fn test_static_spendable_outputs_timeout_tx() {
4695         let chanmon_cfgs = create_chanmon_cfgs(2);
4696         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4697         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4698         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4699
4700         // Create some initial channels
4701         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4702
4703         // Rebalance the network a bit by relaying one payment through all the channels ...
4704         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4705
4706         let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4707
4708         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4709         assert_eq!(commitment_tx[0].input.len(), 1);
4710         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4711
4712         // Settle A's commitment tx on B' chain
4713         mine_transaction(&nodes[1], &commitment_tx[0]);
4714         check_added_monitors!(nodes[1], 1);
4715         let events = nodes[1].node.get_and_clear_pending_msg_events();
4716         match events[0] {
4717                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4718                 _ => panic!("Unexpected event"),
4719         }
4720         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
4721
4722         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4723         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4724         assert_eq!(node_txn.len(), 2); // ChannelManager : 1 local commitent tx, ChannelMonitor: timeout tx
4725         check_spends!(node_txn[0], chan_1.3.clone());
4726         check_spends!(node_txn[1],  commitment_tx[0].clone());
4727         assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4728
4729         mine_transaction(&nodes[1], &node_txn[1]);
4730         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4731         expect_payment_failed!(nodes[1], our_payment_hash, true);
4732
4733         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4734         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
4735         check_spends!(spend_txn[0], commitment_tx[0]);
4736         check_spends!(spend_txn[1], node_txn[1]);
4737         check_spends!(spend_txn[2], node_txn[1], commitment_tx[0]); // All outputs
4738 }
4739
4740 #[test]
4741 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4742         let chanmon_cfgs = create_chanmon_cfgs(2);
4743         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4744         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4745         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4746
4747         // Create some initial channels
4748         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4749
4750         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4751         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4752         assert_eq!(revoked_local_txn[0].input.len(), 1);
4753         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4754
4755         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4756
4757         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4758         check_closed_broadcast!(nodes[1], true);
4759         check_added_monitors!(nodes[1], 1);
4760
4761         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4762         assert_eq!(node_txn.len(), 2);
4763         assert_eq!(node_txn[0].input.len(), 2);
4764         check_spends!(node_txn[0], revoked_local_txn[0]);
4765
4766         mine_transaction(&nodes[1], &node_txn[0]);
4767         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4768
4769         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4770         assert_eq!(spend_txn.len(), 1);
4771         check_spends!(spend_txn[0], node_txn[0]);
4772 }
4773
4774 #[test]
4775 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4776         let mut chanmon_cfgs = create_chanmon_cfgs(2);
4777         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
4778         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4779         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4780         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4781
4782         // Create some initial channels
4783         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4784
4785         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4786         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4787         assert_eq!(revoked_local_txn[0].input.len(), 1);
4788         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4789
4790         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4791
4792         // A will generate HTLC-Timeout from revoked commitment tx
4793         mine_transaction(&nodes[0], &revoked_local_txn[0]);
4794         check_closed_broadcast!(nodes[0], true);
4795         check_added_monitors!(nodes[0], 1);
4796         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
4797
4798         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4799         assert_eq!(revoked_htlc_txn.len(), 2);
4800         check_spends!(revoked_htlc_txn[0], chan_1.3);
4801         assert_eq!(revoked_htlc_txn[1].input.len(), 1);
4802         assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4803         check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
4804         assert_ne!(revoked_htlc_txn[1].lock_time, 0); // HTLC-Timeout
4805
4806         // B will generate justice tx from A's revoked commitment/HTLC tx
4807         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4808         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
4809         check_closed_broadcast!(nodes[1], true);
4810         check_added_monitors!(nodes[1], 1);
4811
4812         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4813         assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
4814         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4815         // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
4816         // transactions next...
4817         assert_eq!(node_txn[0].input.len(), 3);
4818         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
4819
4820         assert_eq!(node_txn[1].input.len(), 2);
4821         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
4822         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
4823                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
4824         } else {
4825                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
4826                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
4827         }
4828
4829         assert_eq!(node_txn[2].input.len(), 1);
4830         check_spends!(node_txn[2], chan_1.3);
4831
4832         mine_transaction(&nodes[1], &node_txn[1]);
4833         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4834
4835         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4836         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4837         assert_eq!(spend_txn.len(), 1);
4838         assert_eq!(spend_txn[0].input.len(), 1);
4839         check_spends!(spend_txn[0], node_txn[1]);
4840 }
4841
4842 #[test]
4843 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4844         let mut chanmon_cfgs = create_chanmon_cfgs(2);
4845         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
4846         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4847         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4848         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4849
4850         // Create some initial channels
4851         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4852
4853         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4854         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4855         assert_eq!(revoked_local_txn[0].input.len(), 1);
4856         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4857
4858         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
4859         assert_eq!(revoked_local_txn[0].output.len(), 2);
4860
4861         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4862
4863         // B will generate HTLC-Success from revoked commitment tx
4864         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4865         check_closed_broadcast!(nodes[1], true);
4866         check_added_monitors!(nodes[1], 1);
4867         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4868
4869         assert_eq!(revoked_htlc_txn.len(), 2);
4870         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4871         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4872         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4873
4874         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
4875         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
4876         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
4877
4878         // A will generate justice tx from B's revoked commitment/HTLC tx
4879         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4880         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
4881         check_closed_broadcast!(nodes[0], true);
4882         check_added_monitors!(nodes[0], 1);
4883
4884         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4885         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4886
4887         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4888         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
4889         // transactions next...
4890         assert_eq!(node_txn[0].input.len(), 2);
4891         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4892         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4893                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4894         } else {
4895                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
4896                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4897         }
4898
4899         assert_eq!(node_txn[1].input.len(), 1);
4900         check_spends!(node_txn[1], revoked_htlc_txn[0]);
4901
4902         check_spends!(node_txn[2], chan_1.3);
4903
4904         mine_transaction(&nodes[0], &node_txn[1]);
4905         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
4906
4907         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
4908         // didn't try to generate any new transactions.
4909
4910         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4911         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
4912         assert_eq!(spend_txn.len(), 3);
4913         assert_eq!(spend_txn[0].input.len(), 1);
4914         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
4915         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4916         check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
4917         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
4918 }
4919
4920 #[test]
4921 fn test_onchain_to_onchain_claim() {
4922         // Test that in case of channel closure, we detect the state of output and claim HTLC
4923         // on downstream peer's remote commitment tx.
4924         // First, have C claim an HTLC against its own latest commitment transaction.
4925         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4926         // channel.
4927         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4928         // gets broadcast.
4929
4930         let chanmon_cfgs = create_chanmon_cfgs(3);
4931         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4932         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4933         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4934
4935         // Create some initial channels
4936         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4937         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4938
4939         // Ensure all nodes are at the same height
4940         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
4941         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
4942         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
4943         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
4944
4945         // Rebalance the network a bit by relaying one payment through all the channels ...
4946         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
4947         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
4948
4949         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
4950         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
4951         check_spends!(commitment_tx[0], chan_2.3);
4952         nodes[2].node.claim_funds(payment_preimage);
4953         check_added_monitors!(nodes[2], 1);
4954         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4955         assert!(updates.update_add_htlcs.is_empty());
4956         assert!(updates.update_fail_htlcs.is_empty());
4957         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4958         assert!(updates.update_fail_malformed_htlcs.is_empty());
4959
4960         mine_transaction(&nodes[2], &commitment_tx[0]);
4961         check_closed_broadcast!(nodes[2], true);
4962         check_added_monitors!(nodes[2], 1);
4963
4964         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
4965         assert_eq!(c_txn.len(), 3);
4966         assert_eq!(c_txn[0], c_txn[2]);
4967         assert_eq!(commitment_tx[0], c_txn[1]);
4968         check_spends!(c_txn[1], chan_2.3);
4969         check_spends!(c_txn[2], c_txn[1]);
4970         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
4971         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4972         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4973         assert_eq!(c_txn[0].lock_time, 0); // Success tx
4974
4975         // 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
4976         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4977         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
4978         check_added_monitors!(nodes[1], 1);
4979         expect_payment_forwarded!(nodes[1], Some(1000), true);
4980         {
4981                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4982                 // ChannelMonitor: claim tx
4983                 assert_eq!(b_txn.len(), 1);
4984                 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
4985                 b_txn.clear();
4986         }
4987         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4988         assert_eq!(msg_events.len(), 3);
4989         check_added_monitors!(nodes[1], 1);
4990         match msg_events[0] {
4991                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4992                 _ => panic!("Unexpected event"),
4993         }
4994         match msg_events[1] {
4995                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
4996                 _ => panic!("Unexpected event"),
4997         }
4998         match msg_events[2] {
4999                 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, .. } } => {
5000                         assert!(update_add_htlcs.is_empty());
5001                         assert!(update_fail_htlcs.is_empty());
5002                         assert_eq!(update_fulfill_htlcs.len(), 1);
5003                         assert!(update_fail_malformed_htlcs.is_empty());
5004                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5005                 },
5006                 _ => panic!("Unexpected event"),
5007         };
5008         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5009         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5010         mine_transaction(&nodes[1], &commitment_tx[0]);
5011         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5012         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5013         assert_eq!(b_txn.len(), 3);
5014         check_spends!(b_txn[1], chan_1.3);
5015         check_spends!(b_txn[2], b_txn[1]);
5016         check_spends!(b_txn[0], commitment_tx[0]);
5017         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5018         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5019         assert_eq!(b_txn[0].lock_time, 0); // Success tx
5020
5021         check_closed_broadcast!(nodes[1], true);
5022         check_added_monitors!(nodes[1], 1);
5023 }
5024
5025 #[test]
5026 fn test_duplicate_payment_hash_one_failure_one_success() {
5027         // Topology : A --> B --> C --> D
5028         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5029         // Note that because C will refuse to generate two payment secrets for the same payment hash,
5030         // we forward one of the payments onwards to D.
5031         let chanmon_cfgs = create_chanmon_cfgs(4);
5032         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5033         // When this test was written, the default base fee floated based on the HTLC count.
5034         // It is now fixed, so we simply set the fee to the expected value here.
5035         let mut config = test_default_channel_config();
5036         config.channel_options.forwarding_fee_base_msat = 196;
5037         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs,
5038                 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5039         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5040
5041         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5042         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5043         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5044
5045         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5046         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5047         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5048         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5049         connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
5050
5051         let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5052
5053         let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5054         // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5055         // script push size limit so that the below script length checks match
5056         // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5057         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph,
5058                 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV - 40, nodes[0].logger).unwrap();
5059         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5060
5061         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5062         assert_eq!(commitment_txn[0].input.len(), 1);
5063         check_spends!(commitment_txn[0], chan_2.3);
5064
5065         mine_transaction(&nodes[1], &commitment_txn[0]);
5066         check_closed_broadcast!(nodes[1], true);
5067         check_added_monitors!(nodes[1], 1);
5068         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
5069
5070         let htlc_timeout_tx;
5071         { // Extract one of the two HTLC-Timeout transaction
5072                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5073                 // ChannelMonitor: timeout tx * 3, ChannelManager: local commitment tx
5074                 assert_eq!(node_txn.len(), 4);
5075                 check_spends!(node_txn[0], chan_2.3);
5076
5077                 check_spends!(node_txn[1], commitment_txn[0]);
5078                 assert_eq!(node_txn[1].input.len(), 1);
5079                 check_spends!(node_txn[2], commitment_txn[0]);
5080                 assert_eq!(node_txn[2].input.len(), 1);
5081                 assert_eq!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
5082                 check_spends!(node_txn[3], commitment_txn[0]);
5083                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[3].input[0].previous_output);
5084
5085                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5086                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5087                 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5088                 htlc_timeout_tx = node_txn[1].clone();
5089         }
5090
5091         nodes[2].node.claim_funds(our_payment_preimage);
5092         mine_transaction(&nodes[2], &commitment_txn[0]);
5093         check_added_monitors!(nodes[2], 2);
5094         let events = nodes[2].node.get_and_clear_pending_msg_events();
5095         match events[0] {
5096                 MessageSendEvent::UpdateHTLCs { .. } => {},
5097                 _ => panic!("Unexpected event"),
5098         }
5099         match events[1] {
5100                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5101                 _ => panic!("Unexepected event"),
5102         }
5103         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5104         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)
5105         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5106         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5107         assert_eq!(htlc_success_txn[0].input.len(), 1);
5108         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5109         assert_eq!(htlc_success_txn[1].input.len(), 1);
5110         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5111         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5112         assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5113         assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5114         assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5115         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5116
5117         mine_transaction(&nodes[1], &htlc_timeout_tx);
5118         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5119         expect_pending_htlcs_forwardable!(nodes[1]);
5120         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5121         assert!(htlc_updates.update_add_htlcs.is_empty());
5122         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5123         let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5124         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5125         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5126         check_added_monitors!(nodes[1], 1);
5127
5128         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5129         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5130         {
5131                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5132         }
5133         expect_payment_failed_with_update!(nodes[0], duplicate_payment_hash, false, chan_2.0.contents.short_channel_id, true);
5134
5135         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5136         // Note that the fee paid is effectively double as the HTLC value (including the nodes[1] fee
5137         // and nodes[2] fee) is rounded down and then claimed in full.
5138         mine_transaction(&nodes[1], &htlc_success_txn[0]);
5139         expect_payment_forwarded!(nodes[1], Some(196*2), true);
5140         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5141         assert!(updates.update_add_htlcs.is_empty());
5142         assert!(updates.update_fail_htlcs.is_empty());
5143         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5144         assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5145         assert!(updates.update_fail_malformed_htlcs.is_empty());
5146         check_added_monitors!(nodes[1], 1);
5147
5148         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5149         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5150
5151         let events = nodes[0].node.get_and_clear_pending_events();
5152         match events[0] {
5153                 Event::PaymentSent { ref payment_preimage } => {
5154                         assert_eq!(*payment_preimage, our_payment_preimage);
5155                 }
5156                 _ => panic!("Unexpected event"),
5157         }
5158 }
5159
5160 #[test]
5161 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5162         let chanmon_cfgs = create_chanmon_cfgs(2);
5163         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5164         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5165         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5166
5167         // Create some initial channels
5168         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5169
5170         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5171         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5172         assert_eq!(local_txn.len(), 1);
5173         assert_eq!(local_txn[0].input.len(), 1);
5174         check_spends!(local_txn[0], chan_1.3);
5175
5176         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5177         nodes[1].node.claim_funds(payment_preimage);
5178         check_added_monitors!(nodes[1], 1);
5179         mine_transaction(&nodes[1], &local_txn[0]);
5180         check_added_monitors!(nodes[1], 1);
5181         let events = nodes[1].node.get_and_clear_pending_msg_events();
5182         match events[0] {
5183                 MessageSendEvent::UpdateHTLCs { .. } => {},
5184                 _ => panic!("Unexpected event"),
5185         }
5186         match events[1] {
5187                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5188                 _ => panic!("Unexepected event"),
5189         }
5190         let node_tx = {
5191                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5192                 assert_eq!(node_txn.len(), 3);
5193                 assert_eq!(node_txn[0], node_txn[2]);
5194                 assert_eq!(node_txn[1], local_txn[0]);
5195                 assert_eq!(node_txn[0].input.len(), 1);
5196                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5197                 check_spends!(node_txn[0], local_txn[0]);
5198                 node_txn[0].clone()
5199         };
5200
5201         mine_transaction(&nodes[1], &node_tx);
5202         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
5203
5204         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5205         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5206         assert_eq!(spend_txn.len(), 1);
5207         assert_eq!(spend_txn[0].input.len(), 1);
5208         check_spends!(spend_txn[0], node_tx);
5209         assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5210 }
5211
5212 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5213         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5214         // unrevoked commitment transaction.
5215         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5216         // a remote RAA before they could be failed backwards (and combinations thereof).
5217         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5218         // use the same payment hashes.
5219         // Thus, we use a six-node network:
5220         //
5221         // A \         / E
5222         //    - C - D -
5223         // B /         \ F
5224         // And test where C fails back to A/B when D announces its latest commitment transaction
5225         let chanmon_cfgs = create_chanmon_cfgs(6);
5226         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5227         // When this test was written, the default base fee floated based on the HTLC count.
5228         // It is now fixed, so we simply set the fee to the expected value here.
5229         let mut config = test_default_channel_config();
5230         config.channel_options.forwarding_fee_base_msat = 196;
5231         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs,
5232                 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5233         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5234         let logger = test_utils::TestLogger::new();
5235
5236         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5237         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5238         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5239         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5240         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5241
5242         // Rebalance and check output sanity...
5243         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5244         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5245         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5246
5247         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5248         // 0th HTLC:
5249         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
5250         // 1st HTLC:
5251         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
5252         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5253         let our_node_id = &nodes[1].node.get_our_node_id();
5254         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph, &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5255         // 2nd HTLC:
5256         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
5257         // 3rd HTLC:
5258         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
5259         // 4th HTLC:
5260         let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5261         // 5th HTLC:
5262         let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5263         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph, &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5264         // 6th HTLC:
5265         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());
5266         // 7th HTLC:
5267         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());
5268
5269         // 8th HTLC:
5270         let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5271         // 9th HTLC:
5272         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph, &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5273         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
5274
5275         // 10th HTLC:
5276         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
5277         // 11th HTLC:
5278         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph, &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5279         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());
5280
5281         // Double-check that six of the new HTLC were added
5282         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5283         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5284         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5285         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5286
5287         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5288         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5289         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5290         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5291         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5292         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5293         check_added_monitors!(nodes[4], 0);
5294         expect_pending_htlcs_forwardable!(nodes[4]);
5295         check_added_monitors!(nodes[4], 1);
5296
5297         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5298         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5299         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5300         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5301         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5302         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5303
5304         // Fail 3rd below-dust and 7th above-dust HTLCs
5305         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5306         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5307         check_added_monitors!(nodes[5], 0);
5308         expect_pending_htlcs_forwardable!(nodes[5]);
5309         check_added_monitors!(nodes[5], 1);
5310
5311         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5312         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5313         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5314         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5315
5316         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5317
5318         expect_pending_htlcs_forwardable!(nodes[3]);
5319         check_added_monitors!(nodes[3], 1);
5320         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5321         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5322         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5323         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5324         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5325         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5326         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5327         if deliver_last_raa {
5328                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5329         } else {
5330                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5331         }
5332
5333         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5334         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5335         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5336         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5337         //
5338         // We now broadcast the latest commitment transaction, which *should* result in failures for
5339         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5340         // the non-broadcast above-dust HTLCs.
5341         //
5342         // Alternatively, we may broadcast the previous commitment transaction, which should only
5343         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5344         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5345
5346         if announce_latest {
5347                 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5348         } else {
5349                 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5350         }
5351         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5352         check_closed_broadcast!(nodes[2], true);
5353         expect_pending_htlcs_forwardable!(nodes[2]);
5354         check_added_monitors!(nodes[2], 3);
5355
5356         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5357         assert_eq!(cs_msgs.len(), 2);
5358         let mut a_done = false;
5359         for msg in cs_msgs {
5360                 match msg {
5361                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5362                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5363                                 // should be failed-backwards here.
5364                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5365                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5366                                         for htlc in &updates.update_fail_htlcs {
5367                                                 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 });
5368                                         }
5369                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5370                                         assert!(!a_done);
5371                                         a_done = true;
5372                                         &nodes[0]
5373                                 } else {
5374                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5375                                         for htlc in &updates.update_fail_htlcs {
5376                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5377                                         }
5378                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5379                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5380                                         &nodes[1]
5381                                 };
5382                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5383                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5384                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5385                                 if announce_latest {
5386                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5387                                         if *node_id == nodes[0].node.get_our_node_id() {
5388                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5389                                         }
5390                                 }
5391                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5392                         },
5393                         _ => panic!("Unexpected event"),
5394                 }
5395         }
5396
5397         let as_events = nodes[0].node.get_and_clear_pending_events();
5398         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5399         let mut as_failds = HashSet::new();
5400         let mut as_updates = 0;
5401         for event in as_events.iter() {
5402                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref network_update, .. } = event {
5403                         assert!(as_failds.insert(*payment_hash));
5404                         if *payment_hash != payment_hash_2 {
5405                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5406                         } else {
5407                                 assert!(!rejected_by_dest);
5408                         }
5409                         if network_update.is_some() {
5410                                 as_updates += 1;
5411                         }
5412                 } else { panic!("Unexpected event"); }
5413         }
5414         assert!(as_failds.contains(&payment_hash_1));
5415         assert!(as_failds.contains(&payment_hash_2));
5416         if announce_latest {
5417                 assert!(as_failds.contains(&payment_hash_3));
5418                 assert!(as_failds.contains(&payment_hash_5));
5419         }
5420         assert!(as_failds.contains(&payment_hash_6));
5421
5422         let bs_events = nodes[1].node.get_and_clear_pending_events();
5423         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5424         let mut bs_failds = HashSet::new();
5425         let mut bs_updates = 0;
5426         for event in bs_events.iter() {
5427                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref network_update, .. } = event {
5428                         assert!(bs_failds.insert(*payment_hash));
5429                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5430                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5431                         } else {
5432                                 assert!(!rejected_by_dest);
5433                         }
5434                         if network_update.is_some() {
5435                                 bs_updates += 1;
5436                         }
5437                 } else { panic!("Unexpected event"); }
5438         }
5439         assert!(bs_failds.contains(&payment_hash_1));
5440         assert!(bs_failds.contains(&payment_hash_2));
5441         if announce_latest {
5442                 assert!(bs_failds.contains(&payment_hash_4));
5443         }
5444         assert!(bs_failds.contains(&payment_hash_5));
5445
5446         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5447         // get a NetworkUpdate. A should have gotten 4 HTLCs which were failed-back due to
5448         // unknown-preimage-etc, B should have gotten 2. Thus, in the
5449         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2 NetworkUpdates.
5450         assert_eq!(as_updates, if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5451         assert_eq!(bs_updates, if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5452 }
5453
5454 #[test]
5455 fn test_fail_backwards_latest_remote_announce_a() {
5456         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5457 }
5458
5459 #[test]
5460 fn test_fail_backwards_latest_remote_announce_b() {
5461         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5462 }
5463
5464 #[test]
5465 fn test_fail_backwards_previous_remote_announce() {
5466         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5467         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5468         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5469 }
5470
5471 #[test]
5472 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5473         let chanmon_cfgs = create_chanmon_cfgs(2);
5474         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5475         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5476         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5477
5478         // Create some initial channels
5479         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5480
5481         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5482         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5483         assert_eq!(local_txn[0].input.len(), 1);
5484         check_spends!(local_txn[0], chan_1.3);
5485
5486         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5487         mine_transaction(&nodes[0], &local_txn[0]);
5488         check_closed_broadcast!(nodes[0], true);
5489         check_added_monitors!(nodes[0], 1);
5490         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5491
5492         let htlc_timeout = {
5493                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5494                 assert_eq!(node_txn.len(), 2);
5495                 check_spends!(node_txn[0], chan_1.3);
5496                 assert_eq!(node_txn[1].input.len(), 1);
5497                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5498                 check_spends!(node_txn[1], local_txn[0]);
5499                 node_txn[1].clone()
5500         };
5501
5502         mine_transaction(&nodes[0], &htlc_timeout);
5503         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5504         expect_payment_failed!(nodes[0], our_payment_hash, true);
5505
5506         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5507         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5508         assert_eq!(spend_txn.len(), 3);
5509         check_spends!(spend_txn[0], local_txn[0]);
5510         assert_eq!(spend_txn[1].input.len(), 1);
5511         check_spends!(spend_txn[1], htlc_timeout);
5512         assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5513         assert_eq!(spend_txn[2].input.len(), 2);
5514         check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5515         assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5516                 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5517 }
5518
5519 #[test]
5520 fn test_key_derivation_params() {
5521         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5522         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5523         // let us re-derive the channel key set to then derive a delayed_payment_key.
5524
5525         let chanmon_cfgs = create_chanmon_cfgs(3);
5526
5527         // We manually create the node configuration to backup the seed.
5528         let seed = [42; 32];
5529         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5530         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);
5531         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() };
5532         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5533         node_cfgs.remove(0);
5534         node_cfgs.insert(0, node);
5535
5536         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5537         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5538
5539         // Create some initial channels
5540         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5541         // for node 0
5542         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5543         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5544         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5545
5546         // Ensure all nodes are at the same height
5547         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5548         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5549         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5550         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5551
5552         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5553         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5554         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5555         assert_eq!(local_txn_1[0].input.len(), 1);
5556         check_spends!(local_txn_1[0], chan_1.3);
5557
5558         // We check funding pubkey are unique
5559         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]));
5560         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]));
5561         if from_0_funding_key_0 == from_1_funding_key_0
5562             || from_0_funding_key_0 == from_1_funding_key_1
5563             || from_0_funding_key_1 == from_1_funding_key_0
5564             || from_0_funding_key_1 == from_1_funding_key_1 {
5565                 panic!("Funding pubkeys aren't unique");
5566         }
5567
5568         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5569         mine_transaction(&nodes[0], &local_txn_1[0]);
5570         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5571         check_closed_broadcast!(nodes[0], true);
5572         check_added_monitors!(nodes[0], 1);
5573
5574         let htlc_timeout = {
5575                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5576                 assert_eq!(node_txn[1].input.len(), 1);
5577                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5578                 check_spends!(node_txn[1], local_txn_1[0]);
5579                 node_txn[1].clone()
5580         };
5581
5582         mine_transaction(&nodes[0], &htlc_timeout);
5583         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5584         expect_payment_failed!(nodes[0], our_payment_hash, true);
5585
5586         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5587         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5588         let spend_txn = check_spendable_outputs!(nodes[0], new_keys_manager);
5589         assert_eq!(spend_txn.len(), 3);
5590         check_spends!(spend_txn[0], local_txn_1[0]);
5591         assert_eq!(spend_txn[1].input.len(), 1);
5592         check_spends!(spend_txn[1], htlc_timeout);
5593         assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5594         assert_eq!(spend_txn[2].input.len(), 2);
5595         check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5596         assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5597                 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5598 }
5599
5600 #[test]
5601 fn test_static_output_closing_tx() {
5602         let chanmon_cfgs = create_chanmon_cfgs(2);
5603         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5604         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5605         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5606
5607         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5608
5609         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5610         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5611
5612         mine_transaction(&nodes[0], &closing_tx);
5613         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5614
5615         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5616         assert_eq!(spend_txn.len(), 1);
5617         check_spends!(spend_txn[0], closing_tx);
5618
5619         mine_transaction(&nodes[1], &closing_tx);
5620         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5621
5622         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5623         assert_eq!(spend_txn.len(), 1);
5624         check_spends!(spend_txn[0], closing_tx);
5625 }
5626
5627 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5628         let chanmon_cfgs = create_chanmon_cfgs(2);
5629         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5630         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5631         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5632         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5633
5634         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5635
5636         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5637         // present in B's local commitment transaction, but none of A's commitment transactions.
5638         assert!(nodes[1].node.claim_funds(our_payment_preimage));
5639         check_added_monitors!(nodes[1], 1);
5640
5641         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5642         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5643         let events = nodes[0].node.get_and_clear_pending_events();
5644         assert_eq!(events.len(), 1);
5645         match events[0] {
5646                 Event::PaymentSent { payment_preimage } => {
5647                         assert_eq!(payment_preimage, our_payment_preimage);
5648                 },
5649                 _ => panic!("Unexpected event"),
5650         }
5651
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
5658         let starting_block = nodes[1].best_block_info();
5659         let mut block = Block {
5660                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5661                 txdata: vec![],
5662         };
5663         for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5664                 connect_block(&nodes[1], &block);
5665                 block.header.prev_blockhash = block.block_hash();
5666         }
5667         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5668         check_closed_broadcast!(nodes[1], true);
5669         check_added_monitors!(nodes[1], 1);
5670 }
5671
5672 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5673         let chanmon_cfgs = create_chanmon_cfgs(2);
5674         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5675         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5676         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5677         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5678         let logger = test_utils::TestLogger::new();
5679
5680         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
5681         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5682         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV, &logger).unwrap();
5683         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5684         check_added_monitors!(nodes[0], 1);
5685
5686         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5687
5688         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5689         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5690         // to "time out" the HTLC.
5691
5692         let starting_block = nodes[1].best_block_info();
5693         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5694
5695         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5696                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5697                 header.prev_blockhash = header.block_hash();
5698         }
5699         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5700         check_closed_broadcast!(nodes[0], true);
5701         check_added_monitors!(nodes[0], 1);
5702 }
5703
5704 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5705         let chanmon_cfgs = create_chanmon_cfgs(3);
5706         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5707         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5708         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5709         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5710
5711         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5712         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5713         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5714         // actually revoked.
5715         let htlc_value = if use_dust { 50000 } else { 3000000 };
5716         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5717         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
5718         expect_pending_htlcs_forwardable!(nodes[1]);
5719         check_added_monitors!(nodes[1], 1);
5720
5721         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5722         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5723         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5724         check_added_monitors!(nodes[0], 1);
5725         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5726         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5727         check_added_monitors!(nodes[1], 1);
5728         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5729         check_added_monitors!(nodes[1], 1);
5730         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5731
5732         if check_revoke_no_close {
5733                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5734                 check_added_monitors!(nodes[0], 1);
5735         }
5736
5737         let starting_block = nodes[1].best_block_info();
5738         let mut block = Block {
5739                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5740                 txdata: vec![],
5741         };
5742         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
5743                 connect_block(&nodes[0], &block);
5744                 block.header.prev_blockhash = block.block_hash();
5745         }
5746         if !check_revoke_no_close {
5747                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5748                 check_closed_broadcast!(nodes[0], true);
5749                 check_added_monitors!(nodes[0], 1);
5750         } else {
5751                 expect_payment_failed!(nodes[0], our_payment_hash, true);
5752         }
5753 }
5754
5755 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5756 // There are only a few cases to test here:
5757 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5758 //    broadcastable commitment transactions result in channel closure,
5759 //  * its included in an unrevoked-but-previous remote commitment transaction,
5760 //  * its included in the latest remote or local commitment transactions.
5761 // We test each of the three possible commitment transactions individually and use both dust and
5762 // non-dust HTLCs.
5763 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5764 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5765 // tested for at least one of the cases in other tests.
5766 #[test]
5767 fn htlc_claim_single_commitment_only_a() {
5768         do_htlc_claim_local_commitment_only(true);
5769         do_htlc_claim_local_commitment_only(false);
5770
5771         do_htlc_claim_current_remote_commitment_only(true);
5772         do_htlc_claim_current_remote_commitment_only(false);
5773 }
5774
5775 #[test]
5776 fn htlc_claim_single_commitment_only_b() {
5777         do_htlc_claim_previous_remote_commitment_only(true, false);
5778         do_htlc_claim_previous_remote_commitment_only(false, false);
5779         do_htlc_claim_previous_remote_commitment_only(true, true);
5780         do_htlc_claim_previous_remote_commitment_only(false, true);
5781 }
5782
5783 #[test]
5784 #[should_panic]
5785 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5786         let chanmon_cfgs = create_chanmon_cfgs(2);
5787         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5788         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5789         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5790         //Force duplicate channel ids
5791         for node in nodes.iter() {
5792                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5793         }
5794
5795         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5796         let channel_value_satoshis=10000;
5797         let push_msat=10001;
5798         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5799         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5800         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
5801
5802         //Create a second channel with a channel_id collision
5803         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5804 }
5805
5806 #[test]
5807 fn bolt2_open_channel_sending_node_checks_part2() {
5808         let chanmon_cfgs = create_chanmon_cfgs(2);
5809         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5810         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5811         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5812
5813         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5814         let channel_value_satoshis=2^24;
5815         let push_msat=10001;
5816         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5817
5818         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5819         let channel_value_satoshis=10000;
5820         // Test when push_msat is equal to 1000 * funding_satoshis.
5821         let push_msat=1000*channel_value_satoshis+1;
5822         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5823
5824         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5825         let channel_value_satoshis=10000;
5826         let push_msat=10001;
5827         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
5828         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5829         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5830
5831         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5832         // 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
5833         assert!(node0_to_1_send_open_channel.channel_flags<=1);
5834
5835         // 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.
5836         assert!(BREAKDOWN_TIMEOUT>0);
5837         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5838
5839         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5840         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
5841         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5842
5843         // 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.
5844         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5845         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5846         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5847         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
5848         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5849 }
5850
5851 #[test]
5852 fn bolt2_open_channel_sane_dust_limit() {
5853         let chanmon_cfgs = create_chanmon_cfgs(2);
5854         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5855         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5856         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5857
5858         let channel_value_satoshis=1000000;
5859         let push_msat=10001;
5860         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5861         let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5862         node0_to_1_send_open_channel.dust_limit_satoshis = 661;
5863         node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
5864
5865         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
5866         let events = nodes[1].node.get_and_clear_pending_msg_events();
5867         let err_msg = match events[0] {
5868                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
5869                         msg.clone()
5870                 },
5871                 _ => panic!("Unexpected event"),
5872         };
5873         assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
5874 }
5875
5876 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
5877 // originated from our node, its failure is surfaced to the user. We trigger this failure to
5878 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
5879 // is no longer affordable once it's freed.
5880 #[test]
5881 fn test_fail_holding_cell_htlc_upon_free() {
5882         let chanmon_cfgs = create_chanmon_cfgs(2);
5883         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5884         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5885         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5886         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
5887         let logger = test_utils::TestLogger::new();
5888
5889         // First nodes[0] generates an update_fee, setting the channel's
5890         // pending_update_fee.
5891         {
5892                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
5893                 *feerate_lock += 20;
5894         }
5895         nodes[0].node.timer_tick_occurred();
5896         check_added_monitors!(nodes[0], 1);
5897
5898         let events = nodes[0].node.get_and_clear_pending_msg_events();
5899         assert_eq!(events.len(), 1);
5900         let (update_msg, commitment_signed) = match events[0] {
5901                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5902                         (update_fee.as_ref(), commitment_signed)
5903                 },
5904                 _ => panic!("Unexpected event"),
5905         };
5906
5907         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5908
5909         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5910         let channel_reserve = chan_stat.channel_reserve_msat;
5911         let feerate = get_feerate!(nodes[0], chan.2);
5912
5913         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
5914         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
5915         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
5916         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5917         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
5918
5919         // Send a payment which passes reserve checks but gets stuck in the holding cell.
5920         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
5921         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5922         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
5923
5924         // Flush the pending fee update.
5925         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
5926         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5927         check_added_monitors!(nodes[1], 1);
5928         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
5929         check_added_monitors!(nodes[0], 1);
5930
5931         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
5932         // HTLC, but now that the fee has been raised the payment will now fail, causing
5933         // us to surface its failure to the user.
5934         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5935         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
5936         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);
5937         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 {}",
5938                 hex::encode(our_payment_hash.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
5939         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
5940
5941         // Check that the payment failed to be sent out.
5942         let events = nodes[0].node.get_and_clear_pending_events();
5943         assert_eq!(events.len(), 1);
5944         match &events[0] {
5945                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref network_update, ref error_code, ref error_data, ref all_paths_failed } => {
5946                         assert_eq!(our_payment_hash.clone(), *payment_hash);
5947                         assert_eq!(*rejected_by_dest, false);
5948                         assert_eq!(*all_paths_failed, true);
5949                         assert_eq!(*network_update, None);
5950                         assert_eq!(*error_code, None);
5951                         assert_eq!(*error_data, None);
5952                 },
5953                 _ => panic!("Unexpected event"),
5954         }
5955 }
5956
5957 // Test that if multiple HTLCs are released from the holding cell and one is
5958 // valid but the other is no longer valid upon release, the valid HTLC can be
5959 // successfully completed while the other one fails as expected.
5960 #[test]
5961 fn test_free_and_fail_holding_cell_htlcs() {
5962         let chanmon_cfgs = create_chanmon_cfgs(2);
5963         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5964         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5965         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5966         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
5967         let logger = test_utils::TestLogger::new();
5968
5969         // First nodes[0] generates an update_fee, setting the channel's
5970         // pending_update_fee.
5971         {
5972                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
5973                 *feerate_lock += 200;
5974         }
5975         nodes[0].node.timer_tick_occurred();
5976         check_added_monitors!(nodes[0], 1);
5977
5978         let events = nodes[0].node.get_and_clear_pending_msg_events();
5979         assert_eq!(events.len(), 1);
5980         let (update_msg, commitment_signed) = match events[0] {
5981                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5982                         (update_fee.as_ref(), commitment_signed)
5983                 },
5984                 _ => panic!("Unexpected event"),
5985         };
5986
5987         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5988
5989         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5990         let channel_reserve = chan_stat.channel_reserve_msat;
5991         let feerate = get_feerate!(nodes[0], chan.2);
5992
5993         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
5994         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
5995         let amt_1 = 20000;
5996         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
5997         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
5998         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5999         let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], amt_1, TEST_FINAL_CLTV, &logger).unwrap();
6000         let route_2 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], amt_2, TEST_FINAL_CLTV, &logger).unwrap();
6001
6002         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6003         nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6004         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6005         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6006         nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6007         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6008         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6009
6010         // Flush the pending fee update.
6011         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6012         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6013         check_added_monitors!(nodes[1], 1);
6014         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6015         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6016         check_added_monitors!(nodes[0], 2);
6017
6018         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6019         // but now that the fee has been raised the second payment will now fail, causing us
6020         // to surface its failure to the user. The first payment should succeed.
6021         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6022         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6023         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);
6024         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 {}",
6025                 hex::encode(payment_hash_2.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6026         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6027
6028         // Check that the second payment failed to be sent out.
6029         let events = nodes[0].node.get_and_clear_pending_events();
6030         assert_eq!(events.len(), 1);
6031         match &events[0] {
6032                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref network_update, ref error_code, ref error_data, ref all_paths_failed } => {
6033                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6034                         assert_eq!(*rejected_by_dest, false);
6035                         assert_eq!(*all_paths_failed, true);
6036                         assert_eq!(*network_update, None);
6037                         assert_eq!(*error_code, None);
6038                         assert_eq!(*error_data, None);
6039                 },
6040                 _ => panic!("Unexpected event"),
6041         }
6042
6043         // Complete the first payment and the RAA from the fee update.
6044         let (payment_event, send_raa_event) = {
6045                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6046                 assert_eq!(msgs.len(), 2);
6047                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6048         };
6049         let raa = match send_raa_event {
6050                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6051                 _ => panic!("Unexpected event"),
6052         };
6053         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6054         check_added_monitors!(nodes[1], 1);
6055         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6056         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6057         let events = nodes[1].node.get_and_clear_pending_events();
6058         assert_eq!(events.len(), 1);
6059         match events[0] {
6060                 Event::PendingHTLCsForwardable { .. } => {},
6061                 _ => panic!("Unexpected event"),
6062         }
6063         nodes[1].node.process_pending_htlc_forwards();
6064         let events = nodes[1].node.get_and_clear_pending_events();
6065         assert_eq!(events.len(), 1);
6066         match events[0] {
6067                 Event::PaymentReceived { .. } => {},
6068                 _ => panic!("Unexpected event"),
6069         }
6070         nodes[1].node.claim_funds(payment_preimage_1);
6071         check_added_monitors!(nodes[1], 1);
6072         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6073         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6074         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6075         let events = nodes[0].node.get_and_clear_pending_events();
6076         assert_eq!(events.len(), 1);
6077         match events[0] {
6078                 Event::PaymentSent { ref payment_preimage } => {
6079                         assert_eq!(*payment_preimage, payment_preimage_1);
6080                 }
6081                 _ => panic!("Unexpected event"),
6082         }
6083 }
6084
6085 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6086 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6087 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6088 // once it's freed.
6089 #[test]
6090 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6091         let chanmon_cfgs = create_chanmon_cfgs(3);
6092         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6093         // When this test was written, the default base fee floated based on the HTLC count.
6094         // It is now fixed, so we simply set the fee to the expected value here.
6095         let mut config = test_default_channel_config();
6096         config.channel_options.forwarding_fee_base_msat = 196;
6097         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
6098         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6099         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6100         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6101         let logger = test_utils::TestLogger::new();
6102
6103         // First nodes[1] generates an update_fee, setting the channel's
6104         // pending_update_fee.
6105         {
6106                 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
6107                 *feerate_lock += 20;
6108         }
6109         nodes[1].node.timer_tick_occurred();
6110         check_added_monitors!(nodes[1], 1);
6111
6112         let events = nodes[1].node.get_and_clear_pending_msg_events();
6113         assert_eq!(events.len(), 1);
6114         let (update_msg, commitment_signed) = match events[0] {
6115                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6116                         (update_fee.as_ref(), commitment_signed)
6117                 },
6118                 _ => panic!("Unexpected event"),
6119         };
6120
6121         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6122
6123         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6124         let channel_reserve = chan_stat.channel_reserve_msat;
6125         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6126
6127         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6128         let feemsat = 239;
6129         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6130         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6131         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6132         let payment_event = {
6133                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6134                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6135                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6136                 check_added_monitors!(nodes[0], 1);
6137
6138                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6139                 assert_eq!(events.len(), 1);
6140
6141                 SendEvent::from_event(events.remove(0))
6142         };
6143         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6144         check_added_monitors!(nodes[1], 0);
6145         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6146         expect_pending_htlcs_forwardable!(nodes[1]);
6147
6148         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6149         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6150
6151         // Flush the pending fee update.
6152         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6153         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6154         check_added_monitors!(nodes[2], 1);
6155         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6156         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6157         check_added_monitors!(nodes[1], 2);
6158
6159         // A final RAA message is generated to finalize the fee update.
6160         let events = nodes[1].node.get_and_clear_pending_msg_events();
6161         assert_eq!(events.len(), 1);
6162
6163         let raa_msg = match &events[0] {
6164                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6165                         msg.clone()
6166                 },
6167                 _ => panic!("Unexpected event"),
6168         };
6169
6170         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6171         check_added_monitors!(nodes[2], 1);
6172         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6173
6174         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6175         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6176         assert_eq!(process_htlc_forwards_event.len(), 1);
6177         match &process_htlc_forwards_event[0] {
6178                 &Event::PendingHTLCsForwardable { .. } => {},
6179                 _ => panic!("Unexpected event"),
6180         }
6181
6182         // In response, we call ChannelManager's process_pending_htlc_forwards
6183         nodes[1].node.process_pending_htlc_forwards();
6184         check_added_monitors!(nodes[1], 1);
6185
6186         // This causes the HTLC to be failed backwards.
6187         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6188         assert_eq!(fail_event.len(), 1);
6189         let (fail_msg, commitment_signed) = match &fail_event[0] {
6190                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6191                         assert_eq!(updates.update_add_htlcs.len(), 0);
6192                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6193                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6194                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6195                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6196                 },
6197                 _ => panic!("Unexpected event"),
6198         };
6199
6200         // Pass the failure messages back to nodes[0].
6201         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6202         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6203
6204         // Complete the HTLC failure+removal process.
6205         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6206         check_added_monitors!(nodes[0], 1);
6207         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6208         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6209         check_added_monitors!(nodes[1], 2);
6210         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6211         assert_eq!(final_raa_event.len(), 1);
6212         let raa = match &final_raa_event[0] {
6213                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6214                 _ => panic!("Unexpected event"),
6215         };
6216         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6217         expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_1_2.0.contents.short_channel_id, false);
6218         check_added_monitors!(nodes[0], 1);
6219 }
6220
6221 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6222 // 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.
6223 //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.
6224
6225 #[test]
6226 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6227         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
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, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6233
6234         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6235         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6236         let logger = test_utils::TestLogger::new();
6237         let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6238         route.paths[0][0].fee_msat = 100;
6239
6240         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6241                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6242         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6243         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6244 }
6245
6246 #[test]
6247 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6248         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6249         let chanmon_cfgs = create_chanmon_cfgs(2);
6250         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6251         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6252         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6253         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6254         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6255
6256         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6257         let logger = test_utils::TestLogger::new();
6258         let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6259         route.paths[0][0].fee_msat = 0;
6260         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6261                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6262
6263         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6264         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6265 }
6266
6267 #[test]
6268 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6269         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6270         let chanmon_cfgs = create_chanmon_cfgs(2);
6271         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6272         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6273         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6274         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6275
6276         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6277         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6278         let logger = test_utils::TestLogger::new();
6279         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6280         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6281         check_added_monitors!(nodes[0], 1);
6282         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6283         updates.update_add_htlcs[0].amount_msat = 0;
6284
6285         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6286         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6287         check_closed_broadcast!(nodes[1], true).unwrap();
6288         check_added_monitors!(nodes[1], 1);
6289 }
6290
6291 #[test]
6292 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6293         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6294         //It is enforced when constructing a route.
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, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6300         let logger = test_utils::TestLogger::new();
6301
6302         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6303
6304         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6305         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000000, 500000001, &logger).unwrap();
6306         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6307                 assert_eq!(err, &"Channel CLTV overflowed?"));
6308 }
6309
6310 #[test]
6311 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6312         //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.
6313         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6314         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6315         let chanmon_cfgs = create_chanmon_cfgs(2);
6316         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6317         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6318         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6319         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6320         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6321
6322         let logger = test_utils::TestLogger::new();
6323         for i in 0..max_accepted_htlcs {
6324                 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6325                 let payment_event = {
6326                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6327                         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6328                         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6329                         check_added_monitors!(nodes[0], 1);
6330
6331                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6332                         assert_eq!(events.len(), 1);
6333                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6334                                 assert_eq!(htlcs[0].htlc_id, i);
6335                         } else {
6336                                 assert!(false);
6337                         }
6338                         SendEvent::from_event(events.remove(0))
6339                 };
6340                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6341                 check_added_monitors!(nodes[1], 0);
6342                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6343
6344                 expect_pending_htlcs_forwardable!(nodes[1]);
6345                 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6346         }
6347         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6348         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6349         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6350         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6351                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6352
6353         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6354         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6355 }
6356
6357 #[test]
6358 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6359         //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.
6360         let chanmon_cfgs = create_chanmon_cfgs(2);
6361         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6362         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6363         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6364         let channel_value = 100000;
6365         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6366         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6367
6368         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6369
6370         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6371         // Manually create a route over our max in flight (which our router normally automatically
6372         // limits us to.
6373         let route = Route { paths: vec![vec![RouteHop {
6374            pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6375            short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6376            fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6377         }]] };
6378         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6379                 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)));
6380
6381         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6382         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);
6383
6384         send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6385 }
6386
6387 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6388 #[test]
6389 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6390         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6391         let chanmon_cfgs = create_chanmon_cfgs(2);
6392         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6393         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6394         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6395         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6396         let htlc_minimum_msat: u64;
6397         {
6398                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6399                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6400                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6401         }
6402
6403         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6404         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6405         let logger = test_utils::TestLogger::new();
6406         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV, &logger).unwrap();
6407         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6408         check_added_monitors!(nodes[0], 1);
6409         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6410         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6411         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6412         assert!(nodes[1].node.list_channels().is_empty());
6413         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6414         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()));
6415         check_added_monitors!(nodes[1], 1);
6416 }
6417
6418 #[test]
6419 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6420         //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
6421         let chanmon_cfgs = create_chanmon_cfgs(2);
6422         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6423         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6424         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6425         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6426         let logger = test_utils::TestLogger::new();
6427
6428         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6429         let channel_reserve = chan_stat.channel_reserve_msat;
6430         let feerate = get_feerate!(nodes[0], chan.2);
6431         // The 2* and +1 are for the fee spike reserve.
6432         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6433
6434         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6435         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6436         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6437         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6438         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6439         check_added_monitors!(nodes[0], 1);
6440         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6441
6442         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6443         // at this time channel-initiatee receivers are not required to enforce that senders
6444         // respect the fee_spike_reserve.
6445         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6446         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6447
6448         assert!(nodes[1].node.list_channels().is_empty());
6449         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6450         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6451         check_added_monitors!(nodes[1], 1);
6452 }
6453
6454 #[test]
6455 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6456         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6457         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6458         let chanmon_cfgs = create_chanmon_cfgs(2);
6459         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6460         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6461         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6462         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6463         let logger = test_utils::TestLogger::new();
6464
6465         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6466         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6467
6468         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6469         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 3999999, TEST_FINAL_CLTV, &logger).unwrap();
6470
6471         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6472         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6473         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height, &None).unwrap();
6474         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6475
6476         let mut msg = msgs::UpdateAddHTLC {
6477                 channel_id: chan.2,
6478                 htlc_id: 0,
6479                 amount_msat: 1000,
6480                 payment_hash: our_payment_hash,
6481                 cltv_expiry: htlc_cltv,
6482                 onion_routing_packet: onion_packet.clone(),
6483         };
6484
6485         for i in 0..super::channel::OUR_MAX_HTLCS {
6486                 msg.htlc_id = i as u64;
6487                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6488         }
6489         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6490         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6491
6492         assert!(nodes[1].node.list_channels().is_empty());
6493         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6494         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6495         check_added_monitors!(nodes[1], 1);
6496 }
6497
6498 #[test]
6499 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6500         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6501         let chanmon_cfgs = create_chanmon_cfgs(2);
6502         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6503         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6504         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6505         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6506         let logger = test_utils::TestLogger::new();
6507
6508         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6509         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6510         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6511         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6512         check_added_monitors!(nodes[0], 1);
6513         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6514         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6515         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6516
6517         assert!(nodes[1].node.list_channels().is_empty());
6518         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6519         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6520         check_added_monitors!(nodes[1], 1);
6521 }
6522
6523 #[test]
6524 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6525         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6526         let chanmon_cfgs = create_chanmon_cfgs(2);
6527         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6528         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6529         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6530         let logger = test_utils::TestLogger::new();
6531
6532         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6533         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6534         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6535         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6536         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6537         check_added_monitors!(nodes[0], 1);
6538         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6539         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6540         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6541
6542         assert!(nodes[1].node.list_channels().is_empty());
6543         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6544         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6545         check_added_monitors!(nodes[1], 1);
6546 }
6547
6548 #[test]
6549 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6550         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6551         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6552         // after disconnect and that non-sequential htlc_ids result in a channel failure.
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 logger = test_utils::TestLogger::new();
6558
6559         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6560         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6561         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6562         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6563         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6564         check_added_monitors!(nodes[0], 1);
6565         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6566         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6567
6568         //Disconnect and Reconnect
6569         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6570         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6571         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6572         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6573         assert_eq!(reestablish_1.len(), 1);
6574         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6575         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6576         assert_eq!(reestablish_2.len(), 1);
6577         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6578         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6579         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6580         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6581
6582         //Resend HTLC
6583         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6584         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6585         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6586         check_added_monitors!(nodes[1], 1);
6587         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6588
6589         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6590
6591         assert!(nodes[1].node.list_channels().is_empty());
6592         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6593         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6594         check_added_monitors!(nodes[1], 1);
6595 }
6596
6597 #[test]
6598 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6599         //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.
6600
6601         let chanmon_cfgs = create_chanmon_cfgs(2);
6602         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6603         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6604         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6605         let logger = test_utils::TestLogger::new();
6606         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6607         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6608         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6609         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6610         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6611
6612         check_added_monitors!(nodes[0], 1);
6613         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6614         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6615
6616         let update_msg = msgs::UpdateFulfillHTLC{
6617                 channel_id: chan.2,
6618                 htlc_id: 0,
6619                 payment_preimage: our_payment_preimage,
6620         };
6621
6622         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6623
6624         assert!(nodes[0].node.list_channels().is_empty());
6625         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6626         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()));
6627         check_added_monitors!(nodes[0], 1);
6628 }
6629
6630 #[test]
6631 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6632         //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.
6633
6634         let chanmon_cfgs = create_chanmon_cfgs(2);
6635         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6636         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6637         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6638         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6639         let logger = test_utils::TestLogger::new();
6640
6641         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6642         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6643         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6644         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6645         check_added_monitors!(nodes[0], 1);
6646         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6647         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6648
6649         let update_msg = msgs::UpdateFailHTLC{
6650                 channel_id: chan.2,
6651                 htlc_id: 0,
6652                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6653         };
6654
6655         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_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/fail HTLC \(\d+\) before it had been committed").unwrap().is_match(err_msg.data.as_str()));
6660         check_added_monitors!(nodes[0], 1);
6661 }
6662
6663 #[test]
6664 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6665         //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.
6666
6667         let chanmon_cfgs = create_chanmon_cfgs(2);
6668         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6669         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6670         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6671         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6672         let logger = test_utils::TestLogger::new();
6673
6674         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6675         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6676         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6677         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6678         check_added_monitors!(nodes[0], 1);
6679         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6680         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6681         let update_msg = msgs::UpdateFailMalformedHTLC{
6682                 channel_id: chan.2,
6683                 htlc_id: 0,
6684                 sha256_of_onion: [1; 32],
6685                 failure_code: 0x8000,
6686         };
6687
6688         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6689
6690         assert!(nodes[0].node.list_channels().is_empty());
6691         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6692         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()));
6693         check_added_monitors!(nodes[0], 1);
6694 }
6695
6696 #[test]
6697 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6698         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6699
6700         let chanmon_cfgs = create_chanmon_cfgs(2);
6701         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6702         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6703         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6704         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6705
6706         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6707
6708         nodes[1].node.claim_funds(our_payment_preimage);
6709         check_added_monitors!(nodes[1], 1);
6710
6711         let events = nodes[1].node.get_and_clear_pending_msg_events();
6712         assert_eq!(events.len(), 1);
6713         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6714                 match events[0] {
6715                         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, .. } } => {
6716                                 assert!(update_add_htlcs.is_empty());
6717                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6718                                 assert!(update_fail_htlcs.is_empty());
6719                                 assert!(update_fail_malformed_htlcs.is_empty());
6720                                 assert!(update_fee.is_none());
6721                                 update_fulfill_htlcs[0].clone()
6722                         },
6723                         _ => panic!("Unexpected event"),
6724                 }
6725         };
6726
6727         update_fulfill_msg.htlc_id = 1;
6728
6729         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6730
6731         assert!(nodes[0].node.list_channels().is_empty());
6732         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6733         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6734         check_added_monitors!(nodes[0], 1);
6735 }
6736
6737 #[test]
6738 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6739         //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.
6740
6741         let chanmon_cfgs = create_chanmon_cfgs(2);
6742         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6743         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6744         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6745         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6746
6747         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6748
6749         nodes[1].node.claim_funds(our_payment_preimage);
6750         check_added_monitors!(nodes[1], 1);
6751
6752         let events = nodes[1].node.get_and_clear_pending_msg_events();
6753         assert_eq!(events.len(), 1);
6754         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6755                 match events[0] {
6756                         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, .. } } => {
6757                                 assert!(update_add_htlcs.is_empty());
6758                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6759                                 assert!(update_fail_htlcs.is_empty());
6760                                 assert!(update_fail_malformed_htlcs.is_empty());
6761                                 assert!(update_fee.is_none());
6762                                 update_fulfill_htlcs[0].clone()
6763                         },
6764                         _ => panic!("Unexpected event"),
6765                 }
6766         };
6767
6768         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6769
6770         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6771
6772         assert!(nodes[0].node.list_channels().is_empty());
6773         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6774         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6775         check_added_monitors!(nodes[0], 1);
6776 }
6777
6778 #[test]
6779 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6780         //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.
6781
6782         let chanmon_cfgs = create_chanmon_cfgs(2);
6783         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6784         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6785         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6786         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6787         let logger = test_utils::TestLogger::new();
6788
6789         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6790         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6791         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6792         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6793         check_added_monitors!(nodes[0], 1);
6794
6795         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6796         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6797
6798         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6799         check_added_monitors!(nodes[1], 0);
6800         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6801
6802         let events = nodes[1].node.get_and_clear_pending_msg_events();
6803
6804         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6805                 match events[0] {
6806                         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, .. } } => {
6807                                 assert!(update_add_htlcs.is_empty());
6808                                 assert!(update_fulfill_htlcs.is_empty());
6809                                 assert!(update_fail_htlcs.is_empty());
6810                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6811                                 assert!(update_fee.is_none());
6812                                 update_fail_malformed_htlcs[0].clone()
6813                         },
6814                         _ => panic!("Unexpected event"),
6815                 }
6816         };
6817         update_msg.failure_code &= !0x8000;
6818         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6819
6820         assert!(nodes[0].node.list_channels().is_empty());
6821         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6822         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6823         check_added_monitors!(nodes[0], 1);
6824 }
6825
6826 #[test]
6827 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6828         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6829         //    * 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.
6830
6831         let chanmon_cfgs = create_chanmon_cfgs(3);
6832         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6833         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6834         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6835         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6836         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6837         let logger = test_utils::TestLogger::new();
6838
6839         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6840
6841         //First hop
6842         let mut payment_event = {
6843                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6844                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
6845                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6846                 check_added_monitors!(nodes[0], 1);
6847                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6848                 assert_eq!(events.len(), 1);
6849                 SendEvent::from_event(events.remove(0))
6850         };
6851         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6852         check_added_monitors!(nodes[1], 0);
6853         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6854         expect_pending_htlcs_forwardable!(nodes[1]);
6855         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6856         assert_eq!(events_2.len(), 1);
6857         check_added_monitors!(nodes[1], 1);
6858         payment_event = SendEvent::from_event(events_2.remove(0));
6859         assert_eq!(payment_event.msgs.len(), 1);
6860
6861         //Second Hop
6862         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6863         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6864         check_added_monitors!(nodes[2], 0);
6865         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6866
6867         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6868         assert_eq!(events_3.len(), 1);
6869         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6870                 match events_3[0] {
6871                         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 } } => {
6872                                 assert!(update_add_htlcs.is_empty());
6873                                 assert!(update_fulfill_htlcs.is_empty());
6874                                 assert!(update_fail_htlcs.is_empty());
6875                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6876                                 assert!(update_fee.is_none());
6877                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6878                         },
6879                         _ => panic!("Unexpected event"),
6880                 }
6881         };
6882
6883         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6884
6885         check_added_monitors!(nodes[1], 0);
6886         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6887         expect_pending_htlcs_forwardable!(nodes[1]);
6888         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6889         assert_eq!(events_4.len(), 1);
6890
6891         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6892         match events_4[0] {
6893                 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, .. } } => {
6894                         assert!(update_add_htlcs.is_empty());
6895                         assert!(update_fulfill_htlcs.is_empty());
6896                         assert_eq!(update_fail_htlcs.len(), 1);
6897                         assert!(update_fail_malformed_htlcs.is_empty());
6898                         assert!(update_fee.is_none());
6899                 },
6900                 _ => panic!("Unexpected event"),
6901         };
6902
6903         check_added_monitors!(nodes[1], 1);
6904 }
6905
6906 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6907         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6908         // 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
6909         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6910
6911         let mut chanmon_cfgs = create_chanmon_cfgs(2);
6912         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
6913         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6914         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6915         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6916         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6917
6918         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
6919
6920         // We route 2 dust-HTLCs between A and B
6921         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6922         let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6923         route_payment(&nodes[0], &[&nodes[1]], 1000000);
6924
6925         // Cache one local commitment tx as previous
6926         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6927
6928         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6929         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
6930         check_added_monitors!(nodes[1], 0);
6931         expect_pending_htlcs_forwardable!(nodes[1]);
6932         check_added_monitors!(nodes[1], 1);
6933
6934         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6935         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
6936         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
6937         check_added_monitors!(nodes[0], 1);
6938
6939         // Cache one local commitment tx as lastest
6940         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6941
6942         let events = nodes[0].node.get_and_clear_pending_msg_events();
6943         match events[0] {
6944                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
6945                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6946                 },
6947                 _ => panic!("Unexpected event"),
6948         }
6949         match events[1] {
6950                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
6951                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6952                 },
6953                 _ => panic!("Unexpected event"),
6954         }
6955
6956         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
6957         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
6958         if announce_latest {
6959                 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
6960         } else {
6961                 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
6962         }
6963
6964         check_closed_broadcast!(nodes[0], true);
6965         check_added_monitors!(nodes[0], 1);
6966
6967         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6968         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
6969         let events = nodes[0].node.get_and_clear_pending_events();
6970         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
6971         assert_eq!(events.len(), 2);
6972         let mut first_failed = false;
6973         for event in events {
6974                 match event {
6975                         Event::PaymentFailed { payment_hash, .. } => {
6976                                 if payment_hash == payment_hash_1 {
6977                                         assert!(!first_failed);
6978                                         first_failed = true;
6979                                 } else {
6980                                         assert_eq!(payment_hash, payment_hash_2);
6981                                 }
6982                         }
6983                         _ => panic!("Unexpected event"),
6984                 }
6985         }
6986 }
6987
6988 #[test]
6989 fn test_failure_delay_dust_htlc_local_commitment() {
6990         do_test_failure_delay_dust_htlc_local_commitment(true);
6991         do_test_failure_delay_dust_htlc_local_commitment(false);
6992 }
6993
6994 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
6995         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
6996         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
6997         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
6998         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
6999         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7000         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7001
7002         let chanmon_cfgs = create_chanmon_cfgs(3);
7003         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7004         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7005         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7006         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7007
7008         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7009
7010         let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7011         let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7012
7013         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7014         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7015
7016         // We revoked bs_commitment_tx
7017         if revoked {
7018                 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7019                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7020         }
7021
7022         let mut timeout_tx = Vec::new();
7023         if local {
7024                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7025                 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7026                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7027                 expect_payment_failed!(nodes[0], dust_hash, true);
7028
7029                 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
7030                 check_closed_broadcast!(nodes[0], true);
7031                 check_added_monitors!(nodes[0], 1);
7032                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7033                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7034                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7035                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7036                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7037                 mine_transaction(&nodes[0], &timeout_tx[0]);
7038                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7039                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7040         } else {
7041                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7042                 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7043                 check_closed_broadcast!(nodes[0], true);
7044                 check_added_monitors!(nodes[0], 1);
7045                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7046                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7047                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7048                 if !revoked {
7049                         expect_payment_failed!(nodes[0], dust_hash, true);
7050                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7051                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7052                         mine_transaction(&nodes[0], &timeout_tx[0]);
7053                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7054                         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7055                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7056                 } else {
7057                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7058                         // commitment tx
7059                         let events = nodes[0].node.get_and_clear_pending_events();
7060                         assert_eq!(events.len(), 2);
7061                         let first;
7062                         match events[0] {
7063                                 Event::PaymentFailed { payment_hash, .. } => {
7064                                         if payment_hash == dust_hash { first = true; }
7065                                         else { first = false; }
7066                                 },
7067                                 _ => panic!("Unexpected event"),
7068                         }
7069                         match events[1] {
7070                                 Event::PaymentFailed { payment_hash, .. } => {
7071                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7072                                         else { assert_eq!(payment_hash, dust_hash); }
7073                                 },
7074                                 _ => panic!("Unexpected event"),
7075                         }
7076                 }
7077         }
7078 }
7079
7080 #[test]
7081 fn test_sweep_outbound_htlc_failure_update() {
7082         do_test_sweep_outbound_htlc_failure_update(false, true);
7083         do_test_sweep_outbound_htlc_failure_update(false, false);
7084         do_test_sweep_outbound_htlc_failure_update(true, false);
7085 }
7086
7087 #[test]
7088 fn test_user_configurable_csv_delay() {
7089         // We test our channel constructors yield errors when we pass them absurd csv delay
7090
7091         let mut low_our_to_self_config = UserConfig::default();
7092         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7093         let mut high_their_to_self_config = UserConfig::default();
7094         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7095         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7096         let chanmon_cfgs = create_chanmon_cfgs(2);
7097         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7098         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7099         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7100
7101         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7102         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) {
7103                 match error {
7104                         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())); },
7105                         _ => panic!("Unexpected event"),
7106                 }
7107         } else { assert!(false) }
7108
7109         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7110         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7111         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7112         open_channel.to_self_delay = 200;
7113         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) {
7114                 match error {
7115                         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()));  },
7116                         _ => panic!("Unexpected event"),
7117                 }
7118         } else { assert!(false); }
7119
7120         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7121         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7122         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()));
7123         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7124         accept_channel.to_self_delay = 200;
7125         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7126         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7127                 match action {
7128                         &ErrorAction::SendErrorMessage { ref msg } => {
7129                                 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()));
7130                         },
7131                         _ => { assert!(false); }
7132                 }
7133         } else { assert!(false); }
7134
7135         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7136         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7137         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7138         open_channel.to_self_delay = 200;
7139         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) {
7140                 match error {
7141                         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())); },
7142                         _ => panic!("Unexpected event"),
7143                 }
7144         } else { assert!(false); }
7145 }
7146
7147 #[test]
7148 fn test_data_loss_protect() {
7149         // We want to be sure that :
7150         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7151         //   (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7152         // * we close channel in case of detecting other being fallen behind
7153         // * we are able to claim our own outputs thanks to to_remote being static
7154         // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7155         let persister;
7156         let logger;
7157         let fee_estimator;
7158         let tx_broadcaster;
7159         let chain_source;
7160         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7161         // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7162         // during signing due to revoked tx
7163         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7164         let keys_manager = &chanmon_cfgs[0].keys_manager;
7165         let monitor;
7166         let node_state_0;
7167         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7168         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7169         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7170
7171         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7172
7173         // Cache node A state before any channel update
7174         let previous_node_state = nodes[0].node.encode();
7175         let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7176         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7177
7178         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7179         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7180
7181         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7182         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7183
7184         // Restore node A from previous state
7185         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7186         let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7187         chain_source = test_utils::TestChainSource::new(Network::Testnet);
7188         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7189         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
7190         persister = test_utils::TestPersister::new();
7191         monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7192         node_state_0 = {
7193                 let mut channel_monitors = HashMap::new();
7194                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7195                 <(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 {
7196                         keys_manager: keys_manager,
7197                         fee_estimator: &fee_estimator,
7198                         chain_monitor: &monitor,
7199                         logger: &logger,
7200                         tx_broadcaster: &tx_broadcaster,
7201                         default_config: UserConfig::default(),
7202                         channel_monitors,
7203                 }).unwrap().1
7204         };
7205         nodes[0].node = &node_state_0;
7206         assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7207         nodes[0].chain_monitor = &monitor;
7208         nodes[0].chain_source = &chain_source;
7209
7210         check_added_monitors!(nodes[0], 1);
7211
7212         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7213         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7214
7215         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7216
7217         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7218         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7219         check_added_monitors!(nodes[0], 1);
7220
7221         {
7222                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7223                 assert_eq!(node_txn.len(), 0);
7224         }
7225
7226         let mut reestablish_1 = Vec::with_capacity(1);
7227         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7228                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7229                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7230                         reestablish_1.push(msg.clone());
7231                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7232                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7233                         match action {
7234                                 &ErrorAction::SendErrorMessage { ref msg } => {
7235                                         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");
7236                                 },
7237                                 _ => panic!("Unexpected event!"),
7238                         }
7239                 } else {
7240                         panic!("Unexpected event")
7241                 }
7242         }
7243
7244         // Check we close channel detecting A is fallen-behind
7245         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7246         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7247         check_added_monitors!(nodes[1], 1);
7248
7249
7250         // Check A is able to claim to_remote output
7251         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7252         assert_eq!(node_txn.len(), 1);
7253         check_spends!(node_txn[0], chan.3);
7254         assert_eq!(node_txn[0].output.len(), 2);
7255         mine_transaction(&nodes[0], &node_txn[0]);
7256         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7257         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
7258         assert_eq!(spend_txn.len(), 1);
7259         check_spends!(spend_txn[0], node_txn[0]);
7260 }
7261
7262 #[test]
7263 fn test_check_htlc_underpaying() {
7264         // Send payment through A -> B but A is maliciously
7265         // sending a probe payment (i.e less than expected value0
7266         // to B, B should refuse payment.
7267
7268         let chanmon_cfgs = create_chanmon_cfgs(2);
7269         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7270         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7271         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7272
7273         // Create some initial channels
7274         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7275
7276         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
7277         let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7278         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7279         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7280         check_added_monitors!(nodes[0], 1);
7281
7282         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7283         assert_eq!(events.len(), 1);
7284         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7285         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7286         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7287
7288         // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7289         // and then will wait a second random delay before failing the HTLC back:
7290         expect_pending_htlcs_forwardable!(nodes[1]);
7291         expect_pending_htlcs_forwardable!(nodes[1]);
7292
7293         // Node 3 is expecting payment of 100_000 but received 10_000,
7294         // it should fail htlc like we didn't know the preimage.
7295         nodes[1].node.process_pending_htlc_forwards();
7296
7297         let events = nodes[1].node.get_and_clear_pending_msg_events();
7298         assert_eq!(events.len(), 1);
7299         let (update_fail_htlc, commitment_signed) = match events[0] {
7300                 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 } } => {
7301                         assert!(update_add_htlcs.is_empty());
7302                         assert!(update_fulfill_htlcs.is_empty());
7303                         assert_eq!(update_fail_htlcs.len(), 1);
7304                         assert!(update_fail_malformed_htlcs.is_empty());
7305                         assert!(update_fee.is_none());
7306                         (update_fail_htlcs[0].clone(), commitment_signed)
7307                 },
7308                 _ => panic!("Unexpected event"),
7309         };
7310         check_added_monitors!(nodes[1], 1);
7311
7312         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7313         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7314
7315         // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7316         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7317         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7318         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7319 }
7320
7321 #[test]
7322 fn test_announce_disable_channels() {
7323         // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7324         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7325
7326         let chanmon_cfgs = create_chanmon_cfgs(2);
7327         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7328         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7329         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7330
7331         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7332         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7333         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7334
7335         // Disconnect peers
7336         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7337         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7338
7339         nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7340         nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7341         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7342         assert_eq!(msg_events.len(), 3);
7343         let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7344         for e in msg_events {
7345                 match e {
7346                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7347                                 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7348                                 // Check that each channel gets updated exactly once
7349                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7350                                         panic!("Generated ChannelUpdate for wrong chan!");
7351                                 }
7352                         },
7353                         _ => panic!("Unexpected event"),
7354                 }
7355         }
7356         // Reconnect peers
7357         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7358         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7359         assert_eq!(reestablish_1.len(), 3);
7360         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7361         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7362         assert_eq!(reestablish_2.len(), 3);
7363
7364         // Reestablish chan_1
7365         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7366         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7367         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7368         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7369         // Reestablish chan_2
7370         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7371         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7372         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7373         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7374         // Reestablish chan_3
7375         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7376         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7377         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7378         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7379
7380         nodes[0].node.timer_tick_occurred();
7381         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7382         nodes[0].node.timer_tick_occurred();
7383         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7384         assert_eq!(msg_events.len(), 3);
7385         chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7386         for e in msg_events {
7387                 match e {
7388                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7389                                 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7390                                 // Check that each channel gets updated exactly once
7391                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7392                                         panic!("Generated ChannelUpdate for wrong chan!");
7393                                 }
7394                         },
7395                         _ => panic!("Unexpected event"),
7396                 }
7397         }
7398 }
7399
7400 #[test]
7401 fn test_priv_forwarding_rejection() {
7402         // If we have a private channel with outbound liquidity, and
7403         // UserConfig::accept_forwards_to_priv_channels is set to false, we should reject any attempts
7404         // to forward through that channel.
7405         let chanmon_cfgs = create_chanmon_cfgs(3);
7406         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7407         let mut no_announce_cfg = test_default_channel_config();
7408         no_announce_cfg.channel_options.announced_channel = false;
7409         no_announce_cfg.accept_forwards_to_priv_channels = false;
7410         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(no_announce_cfg), None]);
7411         let persister: test_utils::TestPersister;
7412         let new_chain_monitor: test_utils::TestChainMonitor;
7413         let nodes_1_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
7414         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7415
7416         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
7417
7418         // Note that the create_*_chan functions in utils requires announcement_signatures, which we do
7419         // not send for private channels.
7420         nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
7421         let open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[2].node.get_our_node_id());
7422         nodes[2].node.handle_open_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel);
7423         let accept_channel = get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[1].node.get_our_node_id());
7424         nodes[1].node.handle_accept_channel(&nodes[2].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7425
7426         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[1], 1_000_000, 42);
7427         nodes[1].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
7428         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()));
7429         check_added_monitors!(nodes[2], 1);
7430
7431         nodes[1].node.handle_funding_signed(&nodes[2].node.get_our_node_id(), &get_event_msg!(nodes[2], MessageSendEvent::SendFundingSigned, nodes[1].node.get_our_node_id()));
7432         check_added_monitors!(nodes[1], 1);
7433
7434         let conf_height = core::cmp::max(nodes[1].best_block_info().1 + 1, nodes[2].best_block_info().1 + 1);
7435         confirm_transaction_at(&nodes[1], &tx, conf_height);
7436         connect_blocks(&nodes[1], CHAN_CONFIRM_DEPTH - 1);
7437         confirm_transaction_at(&nodes[2], &tx, conf_height);
7438         connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1);
7439         let as_funding_locked = get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[2].node.get_our_node_id());
7440         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()));
7441         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
7442         nodes[2].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &as_funding_locked);
7443         get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7444
7445         assert!(nodes[0].node.list_usable_channels()[0].is_public);
7446         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
7447         assert!(!nodes[2].node.list_usable_channels()[0].is_public);
7448
7449         // We should always be able to forward through nodes[1] as long as its out through a public
7450         // channel:
7451         send_payment(&nodes[2], &[&nodes[1], &nodes[0]], 10_000);
7452
7453         // ... however, if we send to nodes[2], we will have to pass the private channel from nodes[1]
7454         // to nodes[2], which should be rejected:
7455         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7456         let route = get_route(&nodes[0].node.get_our_node_id(),
7457                 &nodes[0].net_graph_msg_handler.network_graph,
7458                 &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None,
7459                 &[&RouteHint(vec![RouteHintHop {
7460                         src_node_id: nodes[1].node.get_our_node_id(),
7461                         short_channel_id: nodes[2].node.list_channels()[0].short_channel_id.unwrap(),
7462                         fees: RoutingFees { base_msat: 1000, proportional_millionths: 0 },
7463                         cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
7464                         htlc_minimum_msat: None,
7465                         htlc_maximum_msat: None,
7466                 }])], 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
7467
7468         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7469         check_added_monitors!(nodes[0], 1);
7470         let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
7471         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7472         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true);
7473
7474         let htlc_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7475         assert!(htlc_fail_updates.update_add_htlcs.is_empty());
7476         assert_eq!(htlc_fail_updates.update_fail_htlcs.len(), 1);
7477         assert!(htlc_fail_updates.update_fail_malformed_htlcs.is_empty());
7478         assert!(htlc_fail_updates.update_fee.is_none());
7479
7480         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates.update_fail_htlcs[0]);
7481         commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates.commitment_signed, true, true);
7482         expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, nodes[2].node.list_channels()[0].short_channel_id.unwrap(), true);
7483
7484         // Now disconnect nodes[1] from its peers and restart with accept_forwards_to_priv_channels set
7485         // to true. Sadly there is currently no way to change it at runtime.
7486
7487         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7488         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7489
7490         let nodes_1_serialized = nodes[1].node.encode();
7491         let mut monitor_a_serialized = test_utils::TestVecWriter(Vec::new());
7492         let mut monitor_b_serialized = test_utils::TestVecWriter(Vec::new());
7493         {
7494                 let mons = nodes[1].chain_monitor.chain_monitor.monitors.read().unwrap();
7495                 let mut mon_iter = mons.iter();
7496                 mon_iter.next().unwrap().1.write(&mut monitor_a_serialized).unwrap();
7497                 mon_iter.next().unwrap().1.write(&mut monitor_b_serialized).unwrap();
7498         }
7499
7500         persister = test_utils::TestPersister::new();
7501         let keys_manager = &chanmon_cfgs[1].keys_manager;
7502         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);
7503         nodes[1].chain_monitor = &new_chain_monitor;
7504
7505         let mut monitor_a_read = &monitor_a_serialized.0[..];
7506         let mut monitor_b_read = &monitor_b_serialized.0[..];
7507         let (_, mut monitor_a) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_a_read, keys_manager).unwrap();
7508         let (_, mut monitor_b) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_b_read, keys_manager).unwrap();
7509         assert!(monitor_a_read.is_empty());
7510         assert!(monitor_b_read.is_empty());
7511
7512         no_announce_cfg.accept_forwards_to_priv_channels = true;
7513
7514         let mut nodes_1_read = &nodes_1_serialized[..];
7515         let (_, nodes_1_deserialized_tmp) = {
7516                 let mut channel_monitors = HashMap::new();
7517                 channel_monitors.insert(monitor_a.get_funding_txo().0, &mut monitor_a);
7518                 channel_monitors.insert(monitor_b.get_funding_txo().0, &mut monitor_b);
7519                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_1_read, ChannelManagerReadArgs {
7520                         default_config: no_announce_cfg,
7521                         keys_manager,
7522                         fee_estimator: node_cfgs[1].fee_estimator,
7523                         chain_monitor: nodes[1].chain_monitor,
7524                         tx_broadcaster: nodes[1].tx_broadcaster.clone(),
7525                         logger: nodes[1].logger,
7526                         channel_monitors,
7527                 }).unwrap()
7528         };
7529         assert!(nodes_1_read.is_empty());
7530         nodes_1_deserialized = nodes_1_deserialized_tmp;
7531
7532         assert!(nodes[1].chain_monitor.watch_channel(monitor_a.get_funding_txo().0, monitor_a).is_ok());
7533         assert!(nodes[1].chain_monitor.watch_channel(monitor_b.get_funding_txo().0, monitor_b).is_ok());
7534         check_added_monitors!(nodes[1], 2);
7535         nodes[1].node = &nodes_1_deserialized;
7536
7537         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
7538         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7539         let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
7540         let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
7541         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
7542         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
7543         get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7544         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
7545
7546         nodes[1].node.peer_connected(&nodes[2].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
7547         nodes[2].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7548         let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[2].node.get_our_node_id());
7549         let cs_reestablish = get_event_msg!(nodes[2], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
7550         nodes[2].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
7551         nodes[1].node.handle_channel_reestablish(&nodes[2].node.get_our_node_id(), &cs_reestablish);
7552         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
7553         get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7554
7555         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7556         check_added_monitors!(nodes[0], 1);
7557         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 10_000, our_payment_hash, our_payment_secret);
7558         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], our_payment_preimage);
7559 }
7560
7561 #[test]
7562 fn test_bump_penalty_txn_on_revoked_commitment() {
7563         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7564         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7565
7566         let chanmon_cfgs = create_chanmon_cfgs(2);
7567         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7568         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7569         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7570
7571         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7572         let logger = test_utils::TestLogger::new();
7573
7574         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7575         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7576         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3000000, 30, &logger).unwrap();
7577         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7578
7579         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7580         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7581         assert_eq!(revoked_txn[0].output.len(), 4);
7582         assert_eq!(revoked_txn[0].input.len(), 1);
7583         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7584         let revoked_txid = revoked_txn[0].txid();
7585
7586         let mut penalty_sum = 0;
7587         for outp in revoked_txn[0].output.iter() {
7588                 if outp.script_pubkey.is_v0_p2wsh() {
7589                         penalty_sum += outp.value;
7590                 }
7591         }
7592
7593         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7594         let header_114 = connect_blocks(&nodes[1], 14);
7595
7596         // Actually revoke tx by claiming a HTLC
7597         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7598         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7599         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7600         check_added_monitors!(nodes[1], 1);
7601
7602         // One or more justice tx should have been broadcast, check it
7603         let penalty_1;
7604         let feerate_1;
7605         {
7606                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7607                 assert_eq!(node_txn.len(), 2); // justice tx (broadcasted from ChannelMonitor) + local commitment tx
7608                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7609                 assert_eq!(node_txn[0].output.len(), 1);
7610                 check_spends!(node_txn[0], revoked_txn[0]);
7611                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7612                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7613                 penalty_1 = node_txn[0].txid();
7614                 node_txn.clear();
7615         };
7616
7617         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7618         connect_blocks(&nodes[1], 15);
7619         let mut penalty_2 = penalty_1;
7620         let mut feerate_2 = 0;
7621         {
7622                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7623                 assert_eq!(node_txn.len(), 1);
7624                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7625                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7626                         assert_eq!(node_txn[0].output.len(), 1);
7627                         check_spends!(node_txn[0], revoked_txn[0]);
7628                         penalty_2 = node_txn[0].txid();
7629                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7630                         assert_ne!(penalty_2, penalty_1);
7631                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7632                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7633                         // Verify 25% bump heuristic
7634                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7635                         node_txn.clear();
7636                 }
7637         }
7638         assert_ne!(feerate_2, 0);
7639
7640         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7641         connect_blocks(&nodes[1], 1);
7642         let penalty_3;
7643         let mut feerate_3 = 0;
7644         {
7645                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7646                 assert_eq!(node_txn.len(), 1);
7647                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7648                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7649                         assert_eq!(node_txn[0].output.len(), 1);
7650                         check_spends!(node_txn[0], revoked_txn[0]);
7651                         penalty_3 = node_txn[0].txid();
7652                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7653                         assert_ne!(penalty_3, penalty_2);
7654                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7655                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7656                         // Verify 25% bump heuristic
7657                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7658                         node_txn.clear();
7659                 }
7660         }
7661         assert_ne!(feerate_3, 0);
7662
7663         nodes[1].node.get_and_clear_pending_events();
7664         nodes[1].node.get_and_clear_pending_msg_events();
7665 }
7666
7667 #[test]
7668 fn test_bump_penalty_txn_on_revoked_htlcs() {
7669         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7670         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7671
7672         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7673         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
7674         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7675         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7676         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7677
7678         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7679         // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
7680         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph,
7681                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
7682         let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
7683         let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph,
7684                 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
7685         send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
7686
7687         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7688         assert_eq!(revoked_local_txn[0].input.len(), 1);
7689         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7690
7691         // Revoke local commitment tx
7692         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7693
7694         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7695         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7696         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
7697         check_closed_broadcast!(nodes[1], true);
7698         check_added_monitors!(nodes[1], 1);
7699         connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
7700
7701         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7702         assert_eq!(revoked_htlc_txn.len(), 3);
7703         check_spends!(revoked_htlc_txn[1], chan.3);
7704
7705         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7706         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7707         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7708
7709         assert_eq!(revoked_htlc_txn[2].input.len(), 1);
7710         assert_eq!(revoked_htlc_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7711         assert_eq!(revoked_htlc_txn[2].output.len(), 1);
7712         check_spends!(revoked_htlc_txn[2], revoked_local_txn[0]);
7713
7714         // Broadcast set of revoked txn on A
7715         let hash_128 = connect_blocks(&nodes[0], 40);
7716         let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7717         connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
7718         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7719         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[2].clone()] });
7720         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7721         let first;
7722         let feerate_1;
7723         let penalty_txn;
7724         {
7725                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7726                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7727                 // Verify claim tx are spending revoked HTLC txn
7728
7729                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
7730                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
7731                 // which are included in the same block (they are broadcasted because we scan the
7732                 // transactions linearly and generate claims as we go, they likely should be removed in the
7733                 // future).
7734                 assert_eq!(node_txn[0].input.len(), 1);
7735                 check_spends!(node_txn[0], revoked_local_txn[0]);
7736                 assert_eq!(node_txn[1].input.len(), 1);
7737                 check_spends!(node_txn[1], revoked_local_txn[0]);
7738                 assert_eq!(node_txn[2].input.len(), 1);
7739                 check_spends!(node_txn[2], revoked_local_txn[0]);
7740
7741                 // Each of the three justice transactions claim a separate (single) output of the three
7742                 // available, which we check here:
7743                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
7744                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
7745                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
7746
7747                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7748                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
7749
7750                 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
7751                 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
7752                 // a remote commitment tx has already been confirmed).
7753                 check_spends!(node_txn[3], chan.3);
7754
7755                 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
7756                 // output, checked above).
7757                 assert_eq!(node_txn[4].input.len(), 2);
7758                 assert_eq!(node_txn[4].output.len(), 1);
7759                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[2]);
7760
7761                 first = node_txn[4].txid();
7762                 // Store both feerates for later comparison
7763                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[4].output[0].value;
7764                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7765                 penalty_txn = vec![node_txn[2].clone()];
7766                 node_txn.clear();
7767         }
7768
7769         // Connect one more block to see if bumped penalty are issued for HTLC txn
7770         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7771         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
7772         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7773         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
7774         {
7775                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7776                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7777
7778                 check_spends!(node_txn[0], revoked_local_txn[0]);
7779                 check_spends!(node_txn[1], revoked_local_txn[0]);
7780                 // Note that these are both bogus - they spend outputs already claimed in block 129:
7781                 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output  {
7782                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
7783                 } else {
7784                         assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
7785                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7786                 }
7787
7788                 node_txn.clear();
7789         };
7790
7791         // Few more blocks to confirm penalty txn
7792         connect_blocks(&nodes[0], 4);
7793         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7794         let header_144 = connect_blocks(&nodes[0], 9);
7795         let node_txn = {
7796                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7797                 assert_eq!(node_txn.len(), 1);
7798
7799                 assert_eq!(node_txn[0].input.len(), 2);
7800                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[2]);
7801                 // Verify bumped tx is different and 25% bump heuristic
7802                 assert_ne!(first, node_txn[0].txid());
7803                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[0].output[0].value;
7804                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7805                 assert!(feerate_2 * 100 > feerate_1 * 125);
7806                 let txn = vec![node_txn[0].clone()];
7807                 node_txn.clear();
7808                 txn
7809         };
7810         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7811         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7812         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
7813         connect_blocks(&nodes[0], 20);
7814         {
7815                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7816                 // We verify than no new transaction has been broadcast because previously
7817                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7818                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7819                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7820                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7821                 // up bumped justice generation.
7822                 assert_eq!(node_txn.len(), 0);
7823                 node_txn.clear();
7824         }
7825         check_closed_broadcast!(nodes[0], true);
7826         check_added_monitors!(nodes[0], 1);
7827 }
7828
7829 #[test]
7830 fn test_bump_penalty_txn_on_remote_commitment() {
7831         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7832         // we're able to claim outputs on remote commitment transaction before timelocks expiration
7833
7834         // Create 2 HTLCs
7835         // Provide preimage for one
7836         // Check aggregation
7837
7838         let chanmon_cfgs = create_chanmon_cfgs(2);
7839         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7840         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7841         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7842
7843         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7844         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7845         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7846
7847         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7848         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7849         assert_eq!(remote_txn[0].output.len(), 4);
7850         assert_eq!(remote_txn[0].input.len(), 1);
7851         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7852
7853         // Claim a HTLC without revocation (provide B monitor with preimage)
7854         nodes[1].node.claim_funds(payment_preimage);
7855         mine_transaction(&nodes[1], &remote_txn[0]);
7856         check_added_monitors!(nodes[1], 2);
7857         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7858
7859         // One or more claim tx should have been broadcast, check it
7860         let timeout;
7861         let preimage;
7862         let preimage_bump;
7863         let feerate_timeout;
7864         let feerate_preimage;
7865         {
7866                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7867                 // 9 transactions including:
7868                 // 1*2 ChannelManager local broadcasts of commitment + HTLC-Success
7869                 // 1*3 ChannelManager local broadcasts of commitment + HTLC-Success + HTLC-Timeout
7870                 // 2 * HTLC-Success (one RBF bump we'll check later)
7871                 // 1 * HTLC-Timeout
7872                 assert_eq!(node_txn.len(), 8);
7873                 assert_eq!(node_txn[0].input.len(), 1);
7874                 assert_eq!(node_txn[6].input.len(), 1);
7875                 check_spends!(node_txn[0], remote_txn[0]);
7876                 check_spends!(node_txn[6], remote_txn[0]);
7877                 assert_eq!(node_txn[0].input[0].previous_output, node_txn[3].input[0].previous_output);
7878                 preimage_bump = node_txn[3].clone();
7879
7880                 check_spends!(node_txn[1], chan.3);
7881                 check_spends!(node_txn[2], node_txn[1]);
7882                 assert_eq!(node_txn[1], node_txn[4]);
7883                 assert_eq!(node_txn[2], node_txn[5]);
7884
7885                 timeout = node_txn[6].txid();
7886                 let index = node_txn[6].input[0].previous_output.vout;
7887                 let fee = remote_txn[0].output[index as usize].value - node_txn[6].output[0].value;
7888                 feerate_timeout = fee * 1000 / node_txn[6].get_weight() as u64;
7889
7890                 preimage = node_txn[0].txid();
7891                 let index = node_txn[0].input[0].previous_output.vout;
7892                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7893                 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
7894
7895                 node_txn.clear();
7896         };
7897         assert_ne!(feerate_timeout, 0);
7898         assert_ne!(feerate_preimage, 0);
7899
7900         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7901         connect_blocks(&nodes[1], 15);
7902         {
7903                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7904                 assert_eq!(node_txn.len(), 1);
7905                 assert_eq!(node_txn[0].input.len(), 1);
7906                 assert_eq!(preimage_bump.input.len(), 1);
7907                 check_spends!(node_txn[0], remote_txn[0]);
7908                 check_spends!(preimage_bump, remote_txn[0]);
7909
7910                 let index = preimage_bump.input[0].previous_output.vout;
7911                 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
7912                 let new_feerate = fee * 1000 / preimage_bump.get_weight() as u64;
7913                 assert!(new_feerate * 100 > feerate_timeout * 125);
7914                 assert_ne!(timeout, preimage_bump.txid());
7915
7916                 let index = node_txn[0].input[0].previous_output.vout;
7917                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7918                 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7919                 assert!(new_feerate * 100 > feerate_preimage * 125);
7920                 assert_ne!(preimage, node_txn[0].txid());
7921
7922                 node_txn.clear();
7923         }
7924
7925         nodes[1].node.get_and_clear_pending_events();
7926         nodes[1].node.get_and_clear_pending_msg_events();
7927 }
7928
7929 #[test]
7930 fn test_counterparty_raa_skip_no_crash() {
7931         // Previously, if our counterparty sent two RAAs in a row without us having provided a
7932         // commitment transaction, we would have happily carried on and provided them the next
7933         // commitment transaction based on one RAA forward. This would probably eventually have led to
7934         // channel closure, but it would not have resulted in funds loss. Still, our
7935         // EnforcingSigner would have panicked as it doesn't like jumps into the future. Here, we
7936         // check simply that the channel is closed in response to such an RAA, but don't check whether
7937         // we decide to punish our counterparty for revoking their funds (as we don't currently
7938         // implement that).
7939         let chanmon_cfgs = create_chanmon_cfgs(2);
7940         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7941         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7942         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7943         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
7944
7945         let mut guard = nodes[0].node.channel_state.lock().unwrap();
7946         let keys = guard.by_id.get_mut(&channel_id).unwrap().get_signer();
7947
7948         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7949
7950         // Make signer believe we got a counterparty signature, so that it allows the revocation
7951         keys.get_enforcement_state().last_holder_commitment -= 1;
7952         let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
7953
7954         // Must revoke without gaps
7955         keys.get_enforcement_state().last_holder_commitment -= 1;
7956         keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
7957
7958         keys.get_enforcement_state().last_holder_commitment -= 1;
7959         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7960                 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7961
7962         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7963                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
7964         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7965         check_added_monitors!(nodes[1], 1);
7966 }
7967
7968 #[test]
7969 fn test_bump_txn_sanitize_tracking_maps() {
7970         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7971         // verify we clean then right after expiration of ANTI_REORG_DELAY.
7972
7973         let chanmon_cfgs = create_chanmon_cfgs(2);
7974         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7975         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7976         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7977
7978         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7979         // Lock HTLC in both directions
7980         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
7981         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
7982
7983         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7984         assert_eq!(revoked_local_txn[0].input.len(), 1);
7985         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7986
7987         // Revoke local commitment tx
7988         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7989
7990         // Broadcast set of revoked txn on A
7991         connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
7992         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7993         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
7994
7995         mine_transaction(&nodes[0], &revoked_local_txn[0]);
7996         check_closed_broadcast!(nodes[0], true);
7997         check_added_monitors!(nodes[0], 1);
7998         let penalty_txn = {
7999                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8000                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8001                 check_spends!(node_txn[0], revoked_local_txn[0]);
8002                 check_spends!(node_txn[1], revoked_local_txn[0]);
8003                 check_spends!(node_txn[2], revoked_local_txn[0]);
8004                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8005                 node_txn.clear();
8006                 penalty_txn
8007         };
8008         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8009         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8010         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8011         {
8012                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8013                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8014                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8015                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8016                 }
8017         }
8018 }
8019
8020 #[test]
8021 fn test_override_channel_config() {
8022         let chanmon_cfgs = create_chanmon_cfgs(2);
8023         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8024         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8025         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8026
8027         // Node0 initiates a channel to node1 using the override config.
8028         let mut override_config = UserConfig::default();
8029         override_config.own_channel_config.our_to_self_delay = 200;
8030
8031         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8032
8033         // Assert the channel created by node0 is using the override config.
8034         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8035         assert_eq!(res.channel_flags, 0);
8036         assert_eq!(res.to_self_delay, 200);
8037 }
8038
8039 #[test]
8040 fn test_override_0msat_htlc_minimum() {
8041         let mut zero_config = UserConfig::default();
8042         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8043         let chanmon_cfgs = create_chanmon_cfgs(2);
8044         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8045         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8046         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8047
8048         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8049         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8050         assert_eq!(res.htlc_minimum_msat, 1);
8051
8052         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8053         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8054         assert_eq!(res.htlc_minimum_msat, 1);
8055 }
8056
8057 #[test]
8058 fn test_simple_mpp() {
8059         // Simple test of sending a multi-path payment.
8060         let chanmon_cfgs = create_chanmon_cfgs(4);
8061         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8062         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8063         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8064
8065         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8066         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8067         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8068         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8069         let logger = test_utils::TestLogger::new();
8070
8071         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8072         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8073         let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8074         let path = route.paths[0].clone();
8075         route.paths.push(path);
8076         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8077         route.paths[0][0].short_channel_id = chan_1_id;
8078         route.paths[0][1].short_channel_id = chan_3_id;
8079         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8080         route.paths[1][0].short_channel_id = chan_2_id;
8081         route.paths[1][1].short_channel_id = chan_4_id;
8082         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8083         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8084 }
8085
8086 #[test]
8087 fn test_preimage_storage() {
8088         // Simple test of payment preimage storage allowing no client-side storage to claim payments
8089         let chanmon_cfgs = create_chanmon_cfgs(2);
8090         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8091         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8092         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8093
8094         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8095
8096         {
8097                 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8098
8099                 let logger = test_utils::TestLogger::new();
8100                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8101                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8102                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8103                 check_added_monitors!(nodes[0], 1);
8104                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8105                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8106                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8107                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8108         }
8109         // Note that after leaving the above scope we have no knowledge of any arguments or return
8110         // values from previous calls.
8111         expect_pending_htlcs_forwardable!(nodes[1]);
8112         let events = nodes[1].node.get_and_clear_pending_events();
8113         assert_eq!(events.len(), 1);
8114         match events[0] {
8115                 Event::PaymentReceived { ref purpose, .. } => {
8116                         match &purpose {
8117                                 PaymentPurpose::InvoicePayment { payment_preimage, user_payment_id, .. } => {
8118                                         assert_eq!(*user_payment_id, 42);
8119                                         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8120                                 },
8121                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
8122                         }
8123                 },
8124                 _ => panic!("Unexpected event"),
8125         }
8126 }
8127
8128 #[test]
8129 fn test_secret_timeout() {
8130         // Simple test of payment secret storage time outs
8131         let chanmon_cfgs = create_chanmon_cfgs(2);
8132         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8133         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8134         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8135
8136         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8137
8138         let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8139
8140         // We should fail to register the same payment hash twice, at least until we've connected a
8141         // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8142         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8143                 assert_eq!(err, "Duplicate payment hash");
8144         } else { panic!(); }
8145         let mut block = {
8146                 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8147                 Block {
8148                         header: BlockHeader {
8149                                 version: 0x2000000,
8150                                 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8151                                 merkle_root: Default::default(),
8152                                 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8153                         txdata: vec![],
8154                 }
8155         };
8156         connect_block(&nodes[1], &block);
8157         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8158                 assert_eq!(err, "Duplicate payment hash");
8159         } else { panic!(); }
8160
8161         // If we then connect the second block, we should be able to register the same payment hash
8162         // again with a different user_payment_id (this time getting a new payment secret).
8163         block.header.prev_blockhash = block.header.block_hash();
8164         block.header.time += 1;
8165         connect_block(&nodes[1], &block);
8166         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8167         assert_ne!(payment_secret_1, our_payment_secret);
8168
8169         {
8170                 let logger = test_utils::TestLogger::new();
8171                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8172                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8173                 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8174                 check_added_monitors!(nodes[0], 1);
8175                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8176                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8177                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8178                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8179         }
8180         // Note that after leaving the above scope we have no knowledge of any arguments or return
8181         // values from previous calls.
8182         expect_pending_htlcs_forwardable!(nodes[1]);
8183         let events = nodes[1].node.get_and_clear_pending_events();
8184         assert_eq!(events.len(), 1);
8185         match events[0] {
8186                 Event::PaymentReceived { purpose: PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, user_payment_id }, .. } => {
8187                         assert!(payment_preimage.is_none());
8188                         assert_eq!(user_payment_id, 42);
8189                         assert_eq!(payment_secret, our_payment_secret);
8190                         // We don't actually have the payment preimage with which to claim this payment!
8191                 },
8192                 _ => panic!("Unexpected event"),
8193         }
8194 }
8195
8196 #[test]
8197 fn test_bad_secret_hash() {
8198         // Simple test of unregistered payment hash/invalid payment secret handling
8199         let chanmon_cfgs = create_chanmon_cfgs(2);
8200         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8201         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8202         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8203
8204         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8205
8206         let random_payment_hash = PaymentHash([42; 32]);
8207         let random_payment_secret = PaymentSecret([43; 32]);
8208         let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8209
8210         let logger = test_utils::TestLogger::new();
8211         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8212         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8213
8214         // All the below cases should end up being handled exactly identically, so we macro the
8215         // resulting events.
8216         macro_rules! handle_unknown_invalid_payment_data {
8217                 () => {
8218                         check_added_monitors!(nodes[0], 1);
8219                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8220                         let payment_event = SendEvent::from_event(events.pop().unwrap());
8221                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8222                         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8223
8224                         // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8225                         // again to process the pending backwards-failure of the HTLC
8226                         expect_pending_htlcs_forwardable!(nodes[1]);
8227                         expect_pending_htlcs_forwardable!(nodes[1]);
8228                         check_added_monitors!(nodes[1], 1);
8229
8230                         // We should fail the payment back
8231                         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8232                         match events.pop().unwrap() {
8233                                 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8234                                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8235                                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8236                                 },
8237                                 _ => panic!("Unexpected event"),
8238                         }
8239                 }
8240         }
8241
8242         let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8243         // Error data is the HTLC value (100,000) and current block height
8244         let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8245
8246         // Send a payment with the right payment hash but the wrong payment secret
8247         nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8248         handle_unknown_invalid_payment_data!();
8249         expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8250
8251         // Send a payment with a random payment hash, but the right payment secret
8252         nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8253         handle_unknown_invalid_payment_data!();
8254         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8255
8256         // Send a payment with a random payment hash and random payment secret
8257         nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8258         handle_unknown_invalid_payment_data!();
8259         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8260 }
8261
8262 #[test]
8263 fn test_update_err_monitor_lockdown() {
8264         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8265         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8266         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8267         //
8268         // This scenario may happen in a watchtower setup, where watchtower process a block height
8269         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8270         // commitment at same time.
8271
8272         let chanmon_cfgs = create_chanmon_cfgs(2);
8273         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8274         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8275         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8276
8277         // Create some initial channel
8278         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8279         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8280
8281         // Rebalance the network to generate htlc in the two directions
8282         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8283
8284         // Route a HTLC from node 0 to node 1 (but don't settle)
8285         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8286
8287         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8288         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8289         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8290         let persister = test_utils::TestPersister::new();
8291         let watchtower = {
8292                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8293                 let monitor = monitors.get(&outpoint).unwrap();
8294                 let mut w = test_utils::TestVecWriter(Vec::new());
8295                 monitor.write(&mut w).unwrap();
8296                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8297                                 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8298                 assert!(new_monitor == *monitor);
8299                 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);
8300                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8301                 watchtower
8302         };
8303         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8304         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8305         // transaction lock time requirements here.
8306         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (header, 0));
8307         watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8308
8309         // Try to update ChannelMonitor
8310         assert!(nodes[1].node.claim_funds(preimage));
8311         check_added_monitors!(nodes[1], 1);
8312         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8313         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8314         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8315         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8316                 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8317                         if let Err(_) =  watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8318                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8319                 } else { assert!(false); }
8320         } else { assert!(false); };
8321         // Our local monitor is in-sync and hasn't processed yet timeout
8322         check_added_monitors!(nodes[0], 1);
8323         let events = nodes[0].node.get_and_clear_pending_events();
8324         assert_eq!(events.len(), 1);
8325 }
8326
8327 #[test]
8328 fn test_concurrent_monitor_claim() {
8329         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8330         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8331         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8332         // state N+1 confirms. Alice claims output from state N+1.
8333
8334         let chanmon_cfgs = create_chanmon_cfgs(2);
8335         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8336         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8337         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8338
8339         // Create some initial channel
8340         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8341         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8342
8343         // Rebalance the network to generate htlc in the two directions
8344         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8345
8346         // Route a HTLC from node 0 to node 1 (but don't settle)
8347         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8348
8349         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8350         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8351         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8352         let persister = test_utils::TestPersister::new();
8353         let watchtower_alice = {
8354                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8355                 let monitor = monitors.get(&outpoint).unwrap();
8356                 let mut w = test_utils::TestVecWriter(Vec::new());
8357                 monitor.write(&mut w).unwrap();
8358                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8359                                 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8360                 assert!(new_monitor == *monitor);
8361                 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);
8362                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8363                 watchtower
8364         };
8365         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8366         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8367         // transaction lock time requirements here.
8368         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (header, 0));
8369         watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8370
8371         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8372         {
8373                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8374                 assert_eq!(txn.len(), 2);
8375                 txn.clear();
8376         }
8377
8378         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8379         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8380         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8381         let persister = test_utils::TestPersister::new();
8382         let watchtower_bob = {
8383                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8384                 let monitor = monitors.get(&outpoint).unwrap();
8385                 let mut w = test_utils::TestVecWriter(Vec::new());
8386                 monitor.write(&mut w).unwrap();
8387                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8388                                 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8389                 assert!(new_monitor == *monitor);
8390                 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);
8391                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8392                 watchtower
8393         };
8394         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8395         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8396
8397         // Route another payment to generate another update with still previous HTLC pending
8398         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8399         {
8400                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8401                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3000000 , TEST_FINAL_CLTV, &logger).unwrap();
8402                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8403         }
8404         check_added_monitors!(nodes[1], 1);
8405
8406         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8407         assert_eq!(updates.update_add_htlcs.len(), 1);
8408         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8409         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8410                 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8411                         // Watchtower Alice should already have seen the block and reject the update
8412                         if let Err(_) =  watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8413                         if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8414                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8415                 } else { assert!(false); }
8416         } else { assert!(false); };
8417         // Our local monitor is in-sync and hasn't processed yet timeout
8418         check_added_monitors!(nodes[0], 1);
8419
8420         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8421         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8422         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8423
8424         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8425         let bob_state_y;
8426         {
8427                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8428                 assert_eq!(txn.len(), 2);
8429                 bob_state_y = txn[0].clone();
8430                 txn.clear();
8431         };
8432
8433         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8434         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8435         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);
8436         {
8437                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8438                 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8439                 // the onchain detection of the HTLC output
8440                 assert_eq!(htlc_txn.len(), 2);
8441                 check_spends!(htlc_txn[0], bob_state_y);
8442                 check_spends!(htlc_txn[1], bob_state_y);
8443         }
8444 }
8445
8446 #[test]
8447 fn test_pre_lockin_no_chan_closed_update() {
8448         // Test that if a peer closes a channel in response to a funding_created message we don't
8449         // generate a channel update (as the channel cannot appear on chain without a funding_signed
8450         // message).
8451         //
8452         // Doing so would imply a channel monitor update before the initial channel monitor
8453         // registration, violating our API guarantees.
8454         //
8455         // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8456         // then opening a second channel with the same funding output as the first (which is not
8457         // rejected because the first channel does not exist in the ChannelManager) and closing it
8458         // before receiving funding_signed.
8459         let chanmon_cfgs = create_chanmon_cfgs(2);
8460         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8461         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8462         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8463
8464         // Create an initial channel
8465         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8466         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8467         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8468         let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8469         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8470
8471         // Move the first channel through the funding flow...
8472         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8473
8474         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8475         check_added_monitors!(nodes[0], 0);
8476
8477         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8478         let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8479         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8480         assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8481 }
8482
8483 #[test]
8484 fn test_htlc_no_detection() {
8485         // This test is a mutation to underscore the detection logic bug we had
8486         // before #653. HTLC value routed is above the remaining balance, thus
8487         // inverting HTLC and `to_remote` output. HTLC will come second and
8488         // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8489         // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8490         // outputs order detection for correct spending children filtring.
8491
8492         let chanmon_cfgs = create_chanmon_cfgs(2);
8493         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8494         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8495         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8496
8497         // Create some initial channels
8498         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8499
8500         send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8501         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8502         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8503         assert_eq!(local_txn[0].input.len(), 1);
8504         assert_eq!(local_txn[0].output.len(), 3);
8505         check_spends!(local_txn[0], chan_1.3);
8506
8507         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8508         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8509         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8510         // We deliberately connect the local tx twice as this should provoke a failure calling
8511         // this test before #653 fix.
8512         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);
8513         check_closed_broadcast!(nodes[0], true);
8514         check_added_monitors!(nodes[0], 1);
8515         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
8516
8517         let htlc_timeout = {
8518                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8519                 assert_eq!(node_txn[1].input.len(), 1);
8520                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8521                 check_spends!(node_txn[1], local_txn[0]);
8522                 node_txn[1].clone()
8523         };
8524
8525         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8526         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8527         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8528         expect_payment_failed!(nodes[0], our_payment_hash, true);
8529 }
8530
8531 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8532         // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8533         // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8534         // Carol, Alice would be the upstream node, and Carol the downstream.)
8535         //
8536         // Steps of the test:
8537         // 1) Alice sends a HTLC to Carol through Bob.
8538         // 2) Carol doesn't settle the HTLC.
8539         // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8540         // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8541         // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8542         //    but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8543         // 5) Carol release the preimage to Bob off-chain.
8544         // 6) Bob claims the offered output on the broadcasted commitment.
8545         let chanmon_cfgs = create_chanmon_cfgs(3);
8546         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8547         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8548         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8549
8550         // Create some initial channels
8551         let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8552         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8553
8554         // Steps (1) and (2):
8555         // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8556         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8557
8558         // Check that Alice's commitment transaction now contains an output for this HTLC.
8559         let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8560         check_spends!(alice_txn[0], chan_ab.3);
8561         assert_eq!(alice_txn[0].output.len(), 2);
8562         check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8563         assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8564         assert_eq!(alice_txn.len(), 2);
8565
8566         // Steps (3) and (4):
8567         // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8568         // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8569         let mut force_closing_node = 0; // Alice force-closes
8570         if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8571         nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8572         check_closed_broadcast!(nodes[force_closing_node], true);
8573         check_added_monitors!(nodes[force_closing_node], 1);
8574         if go_onchain_before_fulfill {
8575                 let txn_to_broadcast = match broadcast_alice {
8576                         true => alice_txn.clone(),
8577                         false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8578                 };
8579                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8580                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8581                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8582                 if broadcast_alice {
8583                         check_closed_broadcast!(nodes[1], true);
8584                         check_added_monitors!(nodes[1], 1);
8585                 }
8586                 assert_eq!(bob_txn.len(), 1);
8587                 check_spends!(bob_txn[0], chan_ab.3);
8588         }
8589
8590         // Step (5):
8591         // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8592         // process of removing the HTLC from their commitment transactions.
8593         assert!(nodes[2].node.claim_funds(payment_preimage));
8594         check_added_monitors!(nodes[2], 1);
8595         let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8596         assert!(carol_updates.update_add_htlcs.is_empty());
8597         assert!(carol_updates.update_fail_htlcs.is_empty());
8598         assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8599         assert!(carol_updates.update_fee.is_none());
8600         assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8601
8602         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8603         expect_payment_forwarded!(nodes[1], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
8604         // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8605         if !go_onchain_before_fulfill && broadcast_alice {
8606                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8607                 assert_eq!(events.len(), 1);
8608                 match events[0] {
8609                         MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8610                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8611                         },
8612                         _ => panic!("Unexpected event"),
8613                 };
8614         }
8615         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8616         // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8617         // Carol<->Bob's updated commitment transaction info.
8618         check_added_monitors!(nodes[1], 2);
8619
8620         let events = nodes[1].node.get_and_clear_pending_msg_events();
8621         assert_eq!(events.len(), 2);
8622         let bob_revocation = match events[0] {
8623                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8624                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8625                         (*msg).clone()
8626                 },
8627                 _ => panic!("Unexpected event"),
8628         };
8629         let bob_updates = match events[1] {
8630                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8631                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8632                         (*updates).clone()
8633                 },
8634                 _ => panic!("Unexpected event"),
8635         };
8636
8637         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8638         check_added_monitors!(nodes[2], 1);
8639         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8640         check_added_monitors!(nodes[2], 1);
8641
8642         let events = nodes[2].node.get_and_clear_pending_msg_events();
8643         assert_eq!(events.len(), 1);
8644         let carol_revocation = match events[0] {
8645                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8646                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8647                         (*msg).clone()
8648                 },
8649                 _ => panic!("Unexpected event"),
8650         };
8651         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8652         check_added_monitors!(nodes[1], 1);
8653
8654         // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8655         // here's where we put said channel's commitment tx on-chain.
8656         let mut txn_to_broadcast = alice_txn.clone();
8657         if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8658         if !go_onchain_before_fulfill {
8659                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8660                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8661                 // If Bob was the one to force-close, he will have already passed these checks earlier.
8662                 if broadcast_alice {
8663                         check_closed_broadcast!(nodes[1], true);
8664                         check_added_monitors!(nodes[1], 1);
8665                 }
8666                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8667                 if broadcast_alice {
8668                         // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8669                         // new block being connected. The ChannelManager being notified triggers a monitor update,
8670                         // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8671                         // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8672                         // broadcasted.
8673                         assert_eq!(bob_txn.len(), 3);
8674                         check_spends!(bob_txn[1], chan_ab.3);
8675                 } else {
8676                         assert_eq!(bob_txn.len(), 2);
8677                         check_spends!(bob_txn[0], chan_ab.3);
8678                 }
8679         }
8680
8681         // Step (6):
8682         // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8683         // broadcasted commitment transaction.
8684         {
8685                 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8686                 if go_onchain_before_fulfill {
8687                         // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
8688                         assert_eq!(bob_txn.len(), 2);
8689                 }
8690                 let script_weight = match broadcast_alice {
8691                         true => OFFERED_HTLC_SCRIPT_WEIGHT,
8692                         false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8693                 };
8694                 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
8695                 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
8696                 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
8697                 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
8698                 if broadcast_alice && !go_onchain_before_fulfill {
8699                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
8700                         assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
8701                 } else {
8702                         check_spends!(bob_txn[1], txn_to_broadcast[0]);
8703                         assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
8704                 }
8705         }
8706 }
8707
8708 #[test]
8709 fn test_onchain_htlc_settlement_after_close() {
8710         do_test_onchain_htlc_settlement_after_close(true, true);
8711         do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
8712         do_test_onchain_htlc_settlement_after_close(true, false);
8713         do_test_onchain_htlc_settlement_after_close(false, false);
8714 }
8715
8716 #[test]
8717 fn test_duplicate_chan_id() {
8718         // Test that if a given peer tries to open a channel with the same channel_id as one that is
8719         // already open we reject it and keep the old channel.
8720         //
8721         // Previously, full_stack_target managed to figure out that if you tried to open two channels
8722         // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
8723         // the existing channel when we detect the duplicate new channel, screwing up our monitor
8724         // updating logic for the existing channel.
8725         let chanmon_cfgs = create_chanmon_cfgs(2);
8726         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8727         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8728         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8729
8730         // Create an initial channel
8731         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8732         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8733         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8734         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()));
8735
8736         // Try to create a second channel with the same temporary_channel_id as the first and check
8737         // that it is rejected.
8738         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8739         {
8740                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8741                 assert_eq!(events.len(), 1);
8742                 match events[0] {
8743                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8744                                 // Technically, at this point, nodes[1] would be justified in thinking both the
8745                                 // first (valid) and second (invalid) channels are closed, given they both have
8746                                 // the same non-temporary channel_id. However, currently we do not, so we just
8747                                 // move forward with it.
8748                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8749                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8750                         },
8751                         _ => panic!("Unexpected event"),
8752                 }
8753         }
8754
8755         // Move the first channel through the funding flow...
8756         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
8757
8758         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8759         check_added_monitors!(nodes[0], 0);
8760
8761         let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8762         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8763         {
8764                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
8765                 assert_eq!(added_monitors.len(), 1);
8766                 assert_eq!(added_monitors[0].0, funding_output);
8767                 added_monitors.clear();
8768         }
8769         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8770
8771         let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
8772         let channel_id = funding_outpoint.to_channel_id();
8773
8774         // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
8775         // temporary one).
8776
8777         // First try to open a second channel with a temporary channel id equal to the txid-based one.
8778         // Technically this is allowed by the spec, but we don't support it and there's little reason
8779         // to. Still, it shouldn't cause any other issues.
8780         open_chan_msg.temporary_channel_id = channel_id;
8781         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8782         {
8783                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8784                 assert_eq!(events.len(), 1);
8785                 match events[0] {
8786                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8787                                 // Technically, at this point, nodes[1] would be justified in thinking both
8788                                 // channels are closed, but currently we do not, so we just move forward with it.
8789                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8790                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8791                         },
8792                         _ => panic!("Unexpected event"),
8793                 }
8794         }
8795
8796         // Now try to create a second channel which has a duplicate funding output.
8797         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8798         let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8799         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
8800         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()));
8801         create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
8802
8803         let funding_created = {
8804                 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
8805                 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
8806                 let logger = test_utils::TestLogger::new();
8807                 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
8808         };
8809         check_added_monitors!(nodes[0], 0);
8810         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
8811         // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
8812         // still needs to be cleared here.
8813         check_added_monitors!(nodes[1], 1);
8814
8815         // ...still, nodes[1] will reject the duplicate channel.
8816         {
8817                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8818                 assert_eq!(events.len(), 1);
8819                 match events[0] {
8820                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8821                                 // Technically, at this point, nodes[1] would be justified in thinking both
8822                                 // channels are closed, but currently we do not, so we just move forward with it.
8823                                 assert_eq!(msg.channel_id, channel_id);
8824                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8825                         },
8826                         _ => panic!("Unexpected event"),
8827                 }
8828         }
8829
8830         // finally, finish creating the original channel and send a payment over it to make sure
8831         // everything is functional.
8832         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
8833         {
8834                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
8835                 assert_eq!(added_monitors.len(), 1);
8836                 assert_eq!(added_monitors[0].0, funding_output);
8837                 added_monitors.clear();
8838         }
8839
8840         let events_4 = nodes[0].node.get_and_clear_pending_events();
8841         assert_eq!(events_4.len(), 0);
8842         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
8843         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
8844
8845         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8846         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
8847         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
8848         send_payment(&nodes[0], &[&nodes[1]], 8000000);
8849 }
8850
8851 #[test]
8852 fn test_error_chans_closed() {
8853         // Test that we properly handle error messages, closing appropriate channels.
8854         //
8855         // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
8856         // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
8857         // we can test various edge cases around it to ensure we don't regress.
8858         let chanmon_cfgs = create_chanmon_cfgs(3);
8859         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8860         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8861         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8862
8863         // Create some initial channels
8864         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8865         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8866         let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8867
8868         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8869         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
8870         assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
8871
8872         // Closing a channel from a different peer has no effect
8873         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
8874         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8875
8876         // Closing one channel doesn't impact others
8877         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
8878         check_added_monitors!(nodes[0], 1);
8879         check_closed_broadcast!(nodes[0], false);
8880         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
8881         assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
8882         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);
8883         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);
8884
8885         // A null channel ID should close all channels
8886         let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8887         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
8888         check_added_monitors!(nodes[0], 2);
8889         let events = nodes[0].node.get_and_clear_pending_msg_events();
8890         assert_eq!(events.len(), 2);
8891         match events[0] {
8892                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8893                         assert_eq!(msg.contents.flags & 2, 2);
8894                 },
8895                 _ => panic!("Unexpected event"),
8896         }
8897         match events[1] {
8898                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8899                         assert_eq!(msg.contents.flags & 2, 2);
8900                 },
8901                 _ => panic!("Unexpected event"),
8902         }
8903         // Note that at this point users of a standard PeerHandler will end up calling
8904         // peer_disconnected with no_connection_possible set to false, duplicating the
8905         // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
8906         // users with their own peer handling logic. We duplicate the call here, however.
8907         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8908         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8909
8910         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
8911         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8912         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8913 }
8914
8915 #[test]
8916 fn test_invalid_funding_tx() {
8917         // Test that we properly handle invalid funding transactions sent to us from a peer.
8918         //
8919         // Previously, all other major lightning implementations had failed to properly sanitize
8920         // funding transactions from their counterparties, leading to a multi-implementation critical
8921         // security vulnerability (though we always sanitized properly, we've previously had
8922         // un-released crashes in the sanitization process).
8923         let chanmon_cfgs = create_chanmon_cfgs(2);
8924         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8925         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8926         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8927
8928         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
8929         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()));
8930         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()));
8931
8932         let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
8933         for output in tx.output.iter_mut() {
8934                 // Make the confirmed funding transaction have a bogus script_pubkey
8935                 output.script_pubkey = bitcoin::Script::new();
8936         }
8937
8938         nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
8939         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()));
8940         check_added_monitors!(nodes[1], 1);
8941
8942         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()));
8943         check_added_monitors!(nodes[0], 1);
8944
8945         let events_1 = nodes[0].node.get_and_clear_pending_events();
8946         assert_eq!(events_1.len(), 0);
8947
8948         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
8949         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
8950         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
8951
8952         confirm_transaction_at(&nodes[1], &tx, 1);
8953         check_added_monitors!(nodes[1], 1);
8954         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
8955         assert_eq!(events_2.len(), 1);
8956         if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
8957                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8958                 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
8959                         assert_eq!(msg.data, "funding tx had wrong script/value or output index");
8960                 } else { panic!(); }
8961         } else { panic!(); }
8962         assert_eq!(nodes[1].node.list_channels().len(), 0);
8963 }
8964
8965 fn do_test_tx_confirmed_skipping_blocks_immediate_broadcast(test_height_before_timelock: bool) {
8966         // In the first version of the chain::Confirm interface, after a refactor was made to not
8967         // broadcast CSV-locked transactions until their CSV lock is up, we wouldn't reliably broadcast
8968         // transactions after a `transactions_confirmed` call. Specifically, if the chain, provided via
8969         // `best_block_updated` is at height N, and a transaction output which we wish to spend at
8970         // height N-1 (due to a CSV to height N-1) is provided at height N, we will not broadcast the
8971         // spending transaction until height N+1 (or greater). This was due to the way
8972         // `ChannelMonitor::transactions_confirmed` worked, only checking if we should broadcast a
8973         // spending transaction at the height the input transaction was confirmed at, not whether we
8974         // should broadcast a spending transaction at the current height.
8975         // A second, similar, issue involved failing HTLCs backwards - because we only provided the
8976         // height at which transactions were confirmed to `OnchainTx::update_claims_view`, it wasn't
8977         // aware that the anti-reorg-delay had, in fact, already expired, waiting to fail-backwards
8978         // until we learned about an additional block.
8979         //
8980         // As an additional check, if `test_height_before_timelock` is set, we instead test that we
8981         // aren't broadcasting transactions too early (ie not broadcasting them at all).
8982         let chanmon_cfgs = create_chanmon_cfgs(3);
8983         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8984         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8985         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8986         *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
8987
8988         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8989         let (chan_announce, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
8990         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
8991         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
8992         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
8993
8994         nodes[1].node.force_close_channel(&channel_id).unwrap();
8995         check_closed_broadcast!(nodes[1], true);
8996         check_added_monitors!(nodes[1], 1);
8997         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
8998         assert_eq!(node_txn.len(), 1);
8999
9000         let conf_height = nodes[1].best_block_info().1;
9001         if !test_height_before_timelock {
9002                 connect_blocks(&nodes[1], 24 * 6);
9003         }
9004         nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9005                 &nodes[1].get_block_header(conf_height), &[(0, &node_txn[0])], conf_height);
9006         if test_height_before_timelock {
9007                 // If we confirmed the close transaction, but timelocks have not yet expired, we should not
9008                 // generate any events or broadcast any transactions
9009                 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
9010                 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
9011         } else {
9012                 // We should broadcast an HTLC transaction spending our funding transaction first
9013                 let spending_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9014                 assert_eq!(spending_txn.len(), 2);
9015                 assert_eq!(spending_txn[0], node_txn[0]);
9016                 check_spends!(spending_txn[1], node_txn[0]);
9017                 // We should also generate a SpendableOutputs event with the to_self output (as its
9018                 // timelock is up).
9019                 let descriptor_spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
9020                 assert_eq!(descriptor_spend_txn.len(), 1);
9021
9022                 // If we also discover that the HTLC-Timeout transaction was confirmed some time ago, we
9023                 // should immediately fail-backwards the HTLC to the previous hop, without waiting for an
9024                 // additional block built on top of the current chain.
9025                 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9026                         &nodes[1].get_block_header(conf_height + 1), &[(0, &spending_txn[1])], conf_height + 1);
9027                 expect_pending_htlcs_forwardable!(nodes[1]);
9028                 check_added_monitors!(nodes[1], 1);
9029
9030                 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9031                 assert!(updates.update_add_htlcs.is_empty());
9032                 assert!(updates.update_fulfill_htlcs.is_empty());
9033                 assert_eq!(updates.update_fail_htlcs.len(), 1);
9034                 assert!(updates.update_fail_malformed_htlcs.is_empty());
9035                 assert!(updates.update_fee.is_none());
9036                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9037                 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9038                 expect_payment_failed_with_update!(nodes[0], payment_hash, false, chan_announce.contents.short_channel_id, true);
9039         }
9040 }
9041
9042 #[test]
9043 fn test_tx_confirmed_skipping_blocks_immediate_broadcast() {
9044         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(false);
9045         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(true);
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 route = get_route(&payer_pubkey, network_graph, &payee_pubkey, None,
9060                         None, &vec![], 10000, 40,
9061                         nodes[0].logger).unwrap();
9062
9063         let test_preimage = PaymentPreimage([42; 32]);
9064         let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage)).unwrap();
9065         check_added_monitors!(nodes[0], 1);
9066         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9067         assert_eq!(events.len(), 1);
9068         let event = events.pop().unwrap();
9069         let path = vec![&nodes[1]];
9070         pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9071         claim_payment(&nodes[0], &path, test_preimage);
9072 }
9073
9074 #[test]
9075 fn test_keysend_payments_to_private_node() {
9076         let chanmon_cfgs = create_chanmon_cfgs(2);
9077         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9078         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9079         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9080
9081         let payer_pubkey = nodes[0].node.get_our_node_id();
9082         let payee_pubkey = nodes[1].node.get_our_node_id();
9083         nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known() });
9084         nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known() });
9085
9086         let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
9087         let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
9088         let first_hops = nodes[0].node.list_usable_channels();
9089         let route = get_keysend_route(&payer_pubkey, &network_graph, &payee_pubkey,
9090                                 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
9091                                 nodes[0].logger).unwrap();
9092
9093         let test_preimage = PaymentPreimage([42; 32]);
9094         let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage)).unwrap();
9095         check_added_monitors!(nodes[0], 1);
9096         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9097         assert_eq!(events.len(), 1);
9098         let event = events.pop().unwrap();
9099         let path = vec![&nodes[1]];
9100         pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9101         claim_payment(&nodes[0], &path, test_preimage);
9102 }
9103
9104 fn do_test_max_dust_htlc_exposure(dust_outbound_balance: bool, at_forward: bool, on_holder_tx: bool) {
9105         // Test that we properly reject dust HTLC violating our `max_dust_htlc_exposure_msat` policy.
9106         //
9107         // At HTLC forward (`send_payment()`), if the sum of the trimmed-to-dust HTLC inbound and
9108         // trimmed-to-dust HTLC outbound balance and this new payment as included on next counterparty
9109         // commitment are above our `max_dust_htlc_exposure_msat`, we'll reject the update.
9110         // At HTLC reception (`update_add_htlc()`), if the sum of the trimmed-to-dust HTLC inbound
9111         // and trimmed-to-dust HTLC outbound balance and this new received HTLC as included on next
9112         // counterparty commitment are above our `max_dust_htlc_exposure_msat`, we'll fail the update.
9113         // Note, we return a `temporary_channel_failure` (0x1000 | 7), as the channel might be
9114         // available again for HTLC processing once the dust bandwidth has cleared up.
9115
9116         let chanmon_cfgs = create_chanmon_cfgs(2);
9117         let mut config = test_default_channel_config();
9118         config.channel_options.max_dust_htlc_exposure_msat = 5_000_000; // default setting value
9119         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9120         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(config)]);
9121         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9122
9123         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
9124         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9125         open_channel.max_htlc_value_in_flight_msat = 50_000_000;
9126         open_channel.max_accepted_htlcs = 60;
9127         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
9128         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9129         if on_holder_tx {
9130                 accept_channel.dust_limit_satoshis = 660;
9131         }
9132         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
9133
9134         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 1_000_000, 42);
9135
9136         if on_holder_tx {
9137                 if let Some(mut chan) = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&temporary_channel_id) {
9138                         chan.holder_dust_limit_satoshis = 660;
9139                 }
9140         }
9141
9142         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9143         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()));
9144         check_added_monitors!(nodes[1], 1);
9145
9146         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()));
9147         check_added_monitors!(nodes[0], 1);
9148
9149         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9150         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9151         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9152
9153         if on_holder_tx {
9154                 if dust_outbound_balance {
9155                         for i in 0..2 {
9156                                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 2_300_000);
9157                                 if let Err(_) = nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)) { panic!("Unexpected event at dust HTLC {}", i); }
9158                         }
9159                 } else {
9160                         for _ in 0..2 {
9161                                 route_payment(&nodes[0], &[&nodes[1]], 2_300_000);
9162                         }
9163                 }
9164         } else {
9165                 if dust_outbound_balance {
9166                         for i in 0..25 {
9167                                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 200_000); // + 177_000 msat of HTLC-success tx at 253 sats/kWU
9168                                 if let Err(_) = nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)) { panic!("Unexpected event at dust HTLC {}", i); }
9169                         }
9170                 } else {
9171                         for _ in 0..25 {
9172                                 route_payment(&nodes[0], &[&nodes[1]], 200_000); // + 167_000 msat of HTLC-timeout tx at 253 sats/kWU
9173                         }
9174                 }
9175         }
9176
9177         if at_forward {
9178                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], if on_holder_tx { 2_300_000 } else { 200_000 });
9179                 let mut config = UserConfig::default();
9180                 if on_holder_tx {
9181                         unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable { ref err }, assert_eq!(err, &format!("Cannot send value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx", 6_900_000, config.channel_options.max_dust_htlc_exposure_msat)));
9182                 } else {
9183                         unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable { ref err }, assert_eq!(err, &format!("Cannot send value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx", 5_200_000, config.channel_options.max_dust_htlc_exposure_msat)));
9184                 }
9185         } else {
9186                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1 ], if on_holder_tx { 2_300_000 } else { 200_000 });
9187                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
9188                 check_added_monitors!(nodes[0], 1);
9189                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9190                 assert_eq!(events.len(), 1);
9191                 let payment_event = SendEvent::from_event(events.remove(0));
9192                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9193                 if on_holder_tx {
9194                         nodes[1].logger.assert_log("lightning::ln::channel".to_string(), format!("Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx", 6_900_000, config.channel_options.max_dust_htlc_exposure_msat), 1);
9195                 } else {
9196                         nodes[1].logger.assert_log("lightning::ln::channel".to_string(), format!("Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx", 5_200_000, config.channel_options.max_dust_htlc_exposure_msat), 1);
9197                 }
9198         }
9199
9200         let _ = nodes[1].node.get_and_clear_pending_msg_events();
9201         let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9202         added_monitors.clear();
9203 }
9204
9205 #[test]
9206 fn test_max_dust_htlc_exposure() {
9207         do_test_max_dust_htlc_exposure(true, true, true);
9208         do_test_max_dust_htlc_exposure(false, true, true);
9209         do_test_max_dust_htlc_exposure(false, false, true);
9210         do_test_max_dust_htlc_exposure(false, false, false);
9211         do_test_max_dust_htlc_exposure(true, true, false);
9212         do_test_max_dust_htlc_exposure(true, false, false);
9213         do_test_max_dust_htlc_exposure(true, false, true);
9214         do_test_max_dust_htlc_exposure(false, true, false);
9215 }