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

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   7 // You may not use this file except in accordance with one or both of these
   8 // licenses.
   9
  10 //! Tests that test standing up a network of ChannelManagers, creating channels, sending
  11 //! payments/messages between them, and often checking the resulting ChannelMonitors are able to
  12 //! claim outputs on-chain.
  13
  14 use chain;
  15 use chain::{Confirm, Listen, Watch};
  16 use chain::channelmonitor;
  17 use chain::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
  18 use chain::transaction::OutPoint;
  19 use chain::keysinterface::{KeysInterface, BaseSign};
  20 use ln::{PaymentPreimage, PaymentSecret, PaymentHash};
  21 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
  22 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA};
  23 use ln::channel::{Channel, ChannelError};
  24 use ln::{chan_utils, onion_utils};
  25 use routing::router::{Route, RouteHop, get_route};
  26 use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
  27 use ln::msgs;
  28 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
  29 use util::enforcing_trait_impls::EnforcingSigner;
  30 use util::{byte_utils, test_utils};
  31 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
  32 use util::errors::APIError;
  33 use util::ser::{Writeable, ReadableArgs};
  34 use util::config::UserConfig;
  35
  36 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
  37 use bitcoin::hash_types::{Txid, BlockHash};
  38 use bitcoin::blockdata::block::{Block, BlockHeader};
  39 use bitcoin::blockdata::script::Builder;
  40 use bitcoin::blockdata::opcodes;
  41 use bitcoin::blockdata::constants::genesis_block;
  42 use bitcoin::network::constants::Network;
  43
  44 use bitcoin::hashes::sha256::Hash as Sha256;
  45 use bitcoin::hashes::Hash;
  46
  47 use bitcoin::secp256k1::{Secp256k1, Message};
  48 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
  49
  50 use regex;
  51
  52 use prelude::*;
  53 use alloc::collections::BTreeSet;
  54 use core::default::Default;
  55 use std::sync::{Arc, Mutex};
  56
  57 use ln::functional_test_utils::*;
  58 use ln::chan_utils::CommitmentTransaction;
  59 use ln::msgs::OptionalField::Present;
  60
  61 #[test]
  62 fn test_insane_channel_opens() {
  63         // Stand up a network of 2 nodes
  64         let chanmon_cfgs = create_chanmon_cfgs(2);
  65         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  66         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  67         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  68
  69         // Instantiate channel parameters where we push the maximum msats given our
  70         // funding satoshis
  71         let channel_value_sat = 31337; // same as funding satoshis
  72         let channel_reserve_satoshis = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value_sat);
  73         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  74
  75         // Have node0 initiate a channel to node1 with aforementioned parameters
  76         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
  77
  78         // Extract the channel open message from node0 to node1
  79         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  80
  81         // Test helper that asserts we get the correct error string given a mutator
  82         // that supposedly makes the channel open message insane
  83         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  84                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
  85                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  86                 assert_eq!(msg_events.len(), 1);
  87                 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
  88                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  89                         match action {
  90                                 &ErrorAction::SendErrorMessage { .. } => {
  91                                         nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
  92                                 },
  93                                 _ => panic!("unexpected event!"),
  94                         }
  95                 } else { assert!(false); }
  96         };
  97
  98         use ln::channel::MAX_FUNDING_SATOSHIS;
  99         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
 100
 101         // Test all mutations that would make the channel open message insane
 102         insane_open_helper(format!("Funding must be smaller than {}. It was {}", MAX_FUNDING_SATOSHIS, MAX_FUNDING_SATOSHIS).as_str(), |mut msg| { msg.funding_satoshis = MAX_FUNDING_SATOSHIS; msg });
 103
 104         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
 105
 106         insane_open_helper(r"push_msat \d+ was larger than funding value \d+", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
 107
 108         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
 109
 110         insane_open_helper(r"Bogus; channel reserve \(\d+\) is less than dust limit \(\d+\)", |mut msg| { msg.dust_limit_satoshis = msg.channel_reserve_satoshis + 1; msg });
 111
 112         insane_open_helper(r"Minimum htlc value \(\d+\) was larger than full channel value \(\d+\)", |mut msg| { msg.htlc_minimum_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000; msg });
 113
 114         insane_open_helper("They wanted our payments to be delayed by a needlessly long period", |mut msg| { msg.to_self_delay = MAX_LOCAL_BREAKDOWN_TIMEOUT + 1; msg });
 115
 116         insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 117
 118         insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 119 }
 120
 121 #[test]
 122 fn test_async_inbound_update_fee() {
 123         let chanmon_cfgs = create_chanmon_cfgs(2);
 124         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 125         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 126         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 127         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 128         let logger = test_utils::TestLogger::new();
 129         let channel_id = chan.2;
 130
 131         // balancing
 132         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 133
 134         // A                                        B
 135         // update_fee                            ->
 136         // send (1) commitment_signed            -.
 137         //                                       <- update_add_htlc/commitment_signed
 138         // send (2) RAA (awaiting remote revoke) -.
 139         // (1) commitment_signed is delivered    ->
 140         //                                       .- send (3) RAA (awaiting remote revoke)
 141         // (2) RAA is delivered                  ->
 142         //                                       .- send (4) commitment_signed
 143         //                                       <- (3) RAA is delivered
 144         // send (5) commitment_signed            -.
 145         //                                       <- (4) commitment_signed is delivered
 146         // send (6) RAA                          -.
 147         // (5) commitment_signed is delivered    ->
 148         //                                       <- RAA
 149         // (6) RAA is delivered                  ->
 150
 151         // First nodes[0] generates an update_fee
 152         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 153         check_added_monitors!(nodes[0], 1);
 154
 155         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 156         assert_eq!(events_0.len(), 1);
 157         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 158                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 159                         (update_fee.as_ref(), commitment_signed)
 160                 },
 161                 _ => panic!("Unexpected event"),
 162         };
 163
 164         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 165
 166         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 167         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 168         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 169         nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &Some(our_payment_secret)).unwrap();
 170         check_added_monitors!(nodes[1], 1);
 171
 172         let payment_event = {
 173                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 174                 assert_eq!(events_1.len(), 1);
 175                 SendEvent::from_event(events_1.remove(0))
 176         };
 177         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 178         assert_eq!(payment_event.msgs.len(), 1);
 179
 180         // ...now when the messages get delivered everyone should be happy
 181         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 182         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 183         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 184         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 185         check_added_monitors!(nodes[0], 1);
 186
 187         // deliver(1), generate (3):
 188         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 189         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 190         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 191         check_added_monitors!(nodes[1], 1);
 192
 193         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 194         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 195         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 196         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 197         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 198         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 199         assert!(bs_update.update_fee.is_none()); // (4)
 200         check_added_monitors!(nodes[1], 1);
 201
 202         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 203         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 204         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 205         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 206         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 207         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 208         assert!(as_update.update_fee.is_none()); // (5)
 209         check_added_monitors!(nodes[0], 1);
 210
 211         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 212         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 213         // only (6) so get_event_msg's assert(len == 1) passes
 214         check_added_monitors!(nodes[0], 1);
 215
 216         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 217         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 218         check_added_monitors!(nodes[1], 1);
 219
 220         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 221         check_added_monitors!(nodes[0], 1);
 222
 223         let events_2 = nodes[0].node.get_and_clear_pending_events();
 224         assert_eq!(events_2.len(), 1);
 225         match events_2[0] {
 226                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 227                 _ => panic!("Unexpected event"),
 228         }
 229
 230         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 231         check_added_monitors!(nodes[1], 1);
 232 }
 233
 234 #[test]
 235 fn test_update_fee_unordered_raa() {
 236         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 237         // crash in an earlier version of the update_fee patch)
 238         let chanmon_cfgs = create_chanmon_cfgs(2);
 239         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 240         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 241         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 242         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 243         let channel_id = chan.2;
 244         let logger = test_utils::TestLogger::new();
 245
 246         // balancing
 247         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 248
 249         // First nodes[0] generates an update_fee
 250         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 251         check_added_monitors!(nodes[0], 1);
 252
 253         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 254         assert_eq!(events_0.len(), 1);
 255         let update_msg = match events_0[0] { // (1)
 256                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 257                         update_fee.as_ref()
 258                 },
 259                 _ => panic!("Unexpected event"),
 260         };
 261
 262         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 263
 264         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 265         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 266         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 267         nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &Some(our_payment_secret)).unwrap();
 268         check_added_monitors!(nodes[1], 1);
 269
 270         let payment_event = {
 271                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 272                 assert_eq!(events_1.len(), 1);
 273                 SendEvent::from_event(events_1.remove(0))
 274         };
 275         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 276         assert_eq!(payment_event.msgs.len(), 1);
 277
 278         // ...now when the messages get delivered everyone should be happy
 279         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 280         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 281         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 282         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 283         check_added_monitors!(nodes[0], 1);
 284
 285         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 286         check_added_monitors!(nodes[1], 1);
 287
 288         // We can't continue, sadly, because our (1) now has a bogus signature
 289 }
 290
 291 #[test]
 292 fn test_multi_flight_update_fee() {
 293         let chanmon_cfgs = create_chanmon_cfgs(2);
 294         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 295         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 296         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 297         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 298         let channel_id = chan.2;
 299
 300         // A                                        B
 301         // update_fee/commitment_signed          ->
 302         //                                       .- send (1) RAA and (2) commitment_signed
 303         // update_fee (never committed)          ->
 304         // (3) update_fee                        ->
 305         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 306         // don't track which updates correspond to which revoke_and_ack responses so we're in
 307         // AwaitingRAA mode and will not generate the update_fee yet.
 308         //                                       <- (1) RAA delivered
 309         // (3) is generated and send (4) CS      -.
 310         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 311         // know the per_commitment_point to use for it.
 312         //                                       <- (2) commitment_signed delivered
 313         // revoke_and_ack                        ->
 314         //                                          B should send no response here
 315         // (4) commitment_signed delivered       ->
 316         //                                       <- RAA/commitment_signed delivered
 317         // revoke_and_ack                        ->
 318
 319         // First nodes[0] generates an update_fee
 320         let initial_feerate = get_feerate!(nodes[0], channel_id);
 321         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
 322         check_added_monitors!(nodes[0], 1);
 323
 324         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 325         assert_eq!(events_0.len(), 1);
 326         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 327                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 328                         (update_fee.as_ref().unwrap(), commitment_signed)
 329                 },
 330                 _ => panic!("Unexpected event"),
 331         };
 332
 333         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 334         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 335         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 336         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 337         check_added_monitors!(nodes[1], 1);
 338
 339         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 340         // transaction:
 341         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
 342         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 343         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 344
 345         // Create the (3) update_fee message that nodes[0] will generate before it does...
 346         let mut update_msg_2 = msgs::UpdateFee {
 347                 channel_id: update_msg_1.channel_id.clone(),
 348                 feerate_per_kw: (initial_feerate + 30) as u32,
 349         };
 350
 351         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 352
 353         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 354         // Deliver (3)
 355         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 356
 357         // Deliver (1), generating (3) and (4)
 358         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 359         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 360         check_added_monitors!(nodes[0], 1);
 361         assert!(as_second_update.update_add_htlcs.is_empty());
 362         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 363         assert!(as_second_update.update_fail_htlcs.is_empty());
 364         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 365         // Check that the update_fee newly generated matches what we delivered:
 366         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 367         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 368
 369         // Deliver (2) commitment_signed
 370         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 371         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 372         check_added_monitors!(nodes[0], 1);
 373         // No commitment_signed so get_event_msg's assert(len == 1) passes
 374
 375         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 376         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 377         check_added_monitors!(nodes[1], 1);
 378
 379         // Delever (4)
 380         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 381         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 382         check_added_monitors!(nodes[1], 1);
 383
 384         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 385         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 386         check_added_monitors!(nodes[0], 1);
 387
 388         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 389         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 390         // No commitment_signed so get_event_msg's assert(len == 1) passes
 391         check_added_monitors!(nodes[0], 1);
 392
 393         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 394         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 395         check_added_monitors!(nodes[1], 1);
 396 }
 397
 398 fn do_test_1_conf_open(connect_style: ConnectStyle) {
 399         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 400         // tests that we properly send one in that case.
 401         let mut alice_config = UserConfig::default();
 402         alice_config.own_channel_config.minimum_depth = 1;
 403         alice_config.channel_options.announced_channel = true;
 404         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 405         let mut bob_config = UserConfig::default();
 406         bob_config.own_channel_config.minimum_depth = 1;
 407         bob_config.channel_options.announced_channel = true;
 408         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 409         let chanmon_cfgs = create_chanmon_cfgs(2);
 410         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 411         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 412         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 413         *nodes[0].connect_style.borrow_mut() = connect_style;
 414
 415         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
 416         mine_transaction(&nodes[1], &tx);
 417         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[0].node.get_our_node_id()));
 418
 419         mine_transaction(&nodes[0], &tx);
 420         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 421         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 422
 423         for node in nodes {
 424                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
 425                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
 426                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
 427         }
 428 }
 429 #[test]
 430 fn test_1_conf_open() {
 431         do_test_1_conf_open(ConnectStyle::BestBlockFirst);
 432         do_test_1_conf_open(ConnectStyle::TransactionsFirst);
 433         do_test_1_conf_open(ConnectStyle::FullBlockViaListen);
 434 }
 435
 436 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 437         // Previously, we had issues deserializing channels when we hadn't connected the first block
 438         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 439         // serialization round-trips and simply do steps towards opening a channel and then drop the
 440         // Node objects.
 441
 442         let chanmon_cfgs = create_chanmon_cfgs(2);
 443         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 444         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 445         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 446
 447         if steps & 0b1000_0000 != 0{
 448                 let block = Block {
 449                         header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 450                         txdata: vec![],
 451                 };
 452                 connect_block(&nodes[0], &block);
 453                 connect_block(&nodes[1], &block);
 454         }
 455
 456         if steps & 0x0f == 0 { return; }
 457         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 458         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 459
 460         if steps & 0x0f == 1 { return; }
 461         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
 462         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 463
 464         if steps & 0x0f == 2 { return; }
 465         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
 466
 467         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 468
 469         if steps & 0x0f == 3 { return; }
 470         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
 471         check_added_monitors!(nodes[0], 0);
 472         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 473
 474         if steps & 0x0f == 4 { return; }
 475         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 476         {
 477                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 478                 assert_eq!(added_monitors.len(), 1);
 479                 assert_eq!(added_monitors[0].0, funding_output);
 480                 added_monitors.clear();
 481         }
 482         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 483
 484         if steps & 0x0f == 5 { return; }
 485         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 486         {
 487                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 488                 assert_eq!(added_monitors.len(), 1);
 489                 assert_eq!(added_monitors[0].0, funding_output);
 490                 added_monitors.clear();
 491         }
 492
 493         let events_4 = nodes[0].node.get_and_clear_pending_events();
 494         assert_eq!(events_4.len(), 0);
 495
 496         if steps & 0x0f == 6 { return; }
 497         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
 498
 499         if steps & 0x0f == 7 { return; }
 500         confirm_transaction_at(&nodes[0], &tx, 2);
 501         connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
 502         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 503 }
 504
 505 #[test]
 506 fn test_sanity_on_in_flight_opens() {
 507         do_test_sanity_on_in_flight_opens(0);
 508         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 509         do_test_sanity_on_in_flight_opens(1);
 510         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 511         do_test_sanity_on_in_flight_opens(2);
 512         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 513         do_test_sanity_on_in_flight_opens(3);
 514         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 515         do_test_sanity_on_in_flight_opens(4);
 516         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 517         do_test_sanity_on_in_flight_opens(5);
 518         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 519         do_test_sanity_on_in_flight_opens(6);
 520         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 521         do_test_sanity_on_in_flight_opens(7);
 522         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 523         do_test_sanity_on_in_flight_opens(8);
 524         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 525 }
 526
 527 #[test]
 528 fn test_update_fee_vanilla() {
 529         let chanmon_cfgs = create_chanmon_cfgs(2);
 530         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 531         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 532         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 533         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 534         let channel_id = chan.2;
 535
 536         let feerate = get_feerate!(nodes[0], channel_id);
 537         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 538         check_added_monitors!(nodes[0], 1);
 539
 540         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 541         assert_eq!(events_0.len(), 1);
 542         let (update_msg, commitment_signed) = match events_0[0] {
 543                         MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
 544                         (update_fee.as_ref(), commitment_signed)
 545                 },
 546                 _ => panic!("Unexpected event"),
 547         };
 548         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 549
 550         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 551         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 552         check_added_monitors!(nodes[1], 1);
 553
 554         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 555         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 556         check_added_monitors!(nodes[0], 1);
 557
 558         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 559         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 560         // No commitment_signed so get_event_msg's assert(len == 1) passes
 561         check_added_monitors!(nodes[0], 1);
 562
 563         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 564         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 565         check_added_monitors!(nodes[1], 1);
 566 }
 567
 568 #[test]
 569 fn test_update_fee_that_funder_cannot_afford() {
 570         let chanmon_cfgs = create_chanmon_cfgs(2);
 571         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 572         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 573         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 574         let channel_value = 1888;
 575         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
 576         let channel_id = chan.2;
 577
 578         let feerate = 260;
 579         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 580         check_added_monitors!(nodes[0], 1);
 581         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 582
 583         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 584
 585         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 586
 587         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 588         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 589         {
 590                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 591
 592                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 593                 let num_htlcs = commitment_tx.output.len() - 2;
 594                 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 595                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 596                 actual_fee = channel_value - actual_fee;
 597                 assert_eq!(total_fee, actual_fee);
 598         }
 599
 600         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 601         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 602         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 603         check_added_monitors!(nodes[0], 1);
 604
 605         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 606
 607         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 608
 609         //While producing the commitment_signed response after handling a received update_fee request the
 610         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 611         //Should produce and error.
 612         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 613         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 614         check_added_monitors!(nodes[1], 1);
 615         check_closed_broadcast!(nodes[1], true);
 616 }
 617
 618 #[test]
 619 fn test_update_fee_with_fundee_update_add_htlc() {
 620         let chanmon_cfgs = create_chanmon_cfgs(2);
 621         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 622         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 623         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 624         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 625         let channel_id = chan.2;
 626         let logger = test_utils::TestLogger::new();
 627
 628         // balancing
 629         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 630
 631         let feerate = get_feerate!(nodes[0], channel_id);
 632         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 633         check_added_monitors!(nodes[0], 1);
 634
 635         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 636         assert_eq!(events_0.len(), 1);
 637         let (update_msg, commitment_signed) = match events_0[0] {
 638                         MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
 639                         (update_fee.as_ref(), commitment_signed)
 640                 },
 641                 _ => panic!("Unexpected event"),
 642         };
 643         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 644         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 645         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 646         check_added_monitors!(nodes[1], 1);
 647
 648         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 649         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 650         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 800000, TEST_FINAL_CLTV, &logger).unwrap();
 651
 652         // nothing happens since node[1] is in AwaitingRemoteRevoke
 653         nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
 654         {
 655                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 656                 assert_eq!(added_monitors.len(), 0);
 657                 added_monitors.clear();
 658         }
 659         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 660         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 661         // node[1] has nothing to do
 662
 663         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 664         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 665         check_added_monitors!(nodes[0], 1);
 666
 667         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 668         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 669         // No commitment_signed so get_event_msg's assert(len == 1) passes
 670         check_added_monitors!(nodes[0], 1);
 671         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 672         check_added_monitors!(nodes[1], 1);
 673         // AwaitingRemoteRevoke ends here
 674
 675         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 676         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 677         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 678         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 679         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 680         assert_eq!(commitment_update.update_fee.is_none(), true);
 681
 682         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 683         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 684         check_added_monitors!(nodes[0], 1);
 685         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 686
 687         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 688         check_added_monitors!(nodes[1], 1);
 689         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 690
 691         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 692         check_added_monitors!(nodes[1], 1);
 693         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 694         // No commitment_signed so get_event_msg's assert(len == 1) passes
 695
 696         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 697         check_added_monitors!(nodes[0], 1);
 698         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 699
 700         expect_pending_htlcs_forwardable!(nodes[0]);
 701
 702         let events = nodes[0].node.get_and_clear_pending_events();
 703         assert_eq!(events.len(), 1);
 704         match events[0] {
 705                 Event::PaymentReceived { .. } => { },
 706                 _ => panic!("Unexpected event"),
 707         };
 708
 709         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
 710
 711         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
 712         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
 713         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 714 }
 715
 716 #[test]
 717 fn test_update_fee() {
 718         let chanmon_cfgs = create_chanmon_cfgs(2);
 719         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 720         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 721         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 722         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 723         let channel_id = chan.2;
 724
 725         // A                                        B
 726         // (1) update_fee/commitment_signed      ->
 727         //                                       <- (2) revoke_and_ack
 728         //                                       .- send (3) commitment_signed
 729         // (4) update_fee/commitment_signed      ->
 730         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 731         //                                       <- (3) commitment_signed delivered
 732         // send (6) revoke_and_ack               -.
 733         //                                       <- (5) deliver revoke_and_ack
 734         // (6) deliver revoke_and_ack            ->
 735         //                                       .- send (7) commitment_signed in response to (4)
 736         //                                       <- (7) deliver commitment_signed
 737         // revoke_and_ack                        ->
 738
 739         // Create and deliver (1)...
 740         let feerate = get_feerate!(nodes[0], channel_id);
 741         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 742         check_added_monitors!(nodes[0], 1);
 743
 744         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 745         assert_eq!(events_0.len(), 1);
 746         let (update_msg, commitment_signed) = match events_0[0] {
 747                         MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
 748                         (update_fee.as_ref(), commitment_signed)
 749                 },
 750                 _ => panic!("Unexpected event"),
 751         };
 752         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 753
 754         // Generate (2) and (3):
 755         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 756         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 757         check_added_monitors!(nodes[1], 1);
 758
 759         // Deliver (2):
 760         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 761         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 762         check_added_monitors!(nodes[0], 1);
 763
 764         // Create and deliver (4)...
 765         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 766         check_added_monitors!(nodes[0], 1);
 767         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 768         assert_eq!(events_0.len(), 1);
 769         let (update_msg, commitment_signed) = match events_0[0] {
 770                         MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
 771                         (update_fee.as_ref(), commitment_signed)
 772                 },
 773                 _ => panic!("Unexpected event"),
 774         };
 775
 776         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 777         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 778         check_added_monitors!(nodes[1], 1);
 779         // ... creating (5)
 780         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 781         // No commitment_signed so get_event_msg's assert(len == 1) passes
 782
 783         // Handle (3), creating (6):
 784         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 785         check_added_monitors!(nodes[0], 1);
 786         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 787         // No commitment_signed so get_event_msg's assert(len == 1) passes
 788
 789         // Deliver (5):
 790         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 791         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 792         check_added_monitors!(nodes[0], 1);
 793
 794         // Deliver (6), creating (7):
 795         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 796         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 797         assert!(commitment_update.update_add_htlcs.is_empty());
 798         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 799         assert!(commitment_update.update_fail_htlcs.is_empty());
 800         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 801         assert!(commitment_update.update_fee.is_none());
 802         check_added_monitors!(nodes[1], 1);
 803
 804         // Deliver (7)
 805         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 806         check_added_monitors!(nodes[0], 1);
 807         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 808         // No commitment_signed so get_event_msg's assert(len == 1) passes
 809
 810         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 811         check_added_monitors!(nodes[1], 1);
 812         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 813
 814         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 815         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 816         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 817 }
 818
 819 #[test]
 820 fn pre_funding_lock_shutdown_test() {
 821         // Test sending a shutdown prior to funding_locked after funding generation
 822         let chanmon_cfgs = create_chanmon_cfgs(2);
 823         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 824         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 825         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 826         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
 827         mine_transaction(&nodes[0], &tx);
 828         mine_transaction(&nodes[1], &tx);
 829
 830         nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
 831         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 832         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 833         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 834         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 835
 836         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 837         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 838         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 839         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 840         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 841         assert!(node_0_none.is_none());
 842
 843         assert!(nodes[0].node.list_channels().is_empty());
 844         assert!(nodes[1].node.list_channels().is_empty());
 845 }
 846
 847 #[test]
 848 fn updates_shutdown_wait() {
 849         // Test sending a shutdown with outstanding updates pending
 850         let chanmon_cfgs = create_chanmon_cfgs(3);
 851         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 852         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 853         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 854         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 855         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 856         let logger = test_utils::TestLogger::new();
 857
 858         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 859
 860         nodes[0].node.close_channel(&chan_1.2).unwrap();
 861         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 862         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 863         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 864         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 865
 866         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 867         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 868
 869         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
 870
 871         let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
 872         let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
 873         let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 874         let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 875         unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
 876         unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
 877
 878         assert!(nodes[2].node.claim_funds(our_payment_preimage));
 879         check_added_monitors!(nodes[2], 1);
 880         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 881         assert!(updates.update_add_htlcs.is_empty());
 882         assert!(updates.update_fail_htlcs.is_empty());
 883         assert!(updates.update_fail_malformed_htlcs.is_empty());
 884         assert!(updates.update_fee.is_none());
 885         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 886         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 887         check_added_monitors!(nodes[1], 1);
 888         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 889         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 890
 891         assert!(updates_2.update_add_htlcs.is_empty());
 892         assert!(updates_2.update_fail_htlcs.is_empty());
 893         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 894         assert!(updates_2.update_fee.is_none());
 895         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 896         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 897         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 898
 899         let events = nodes[0].node.get_and_clear_pending_events();
 900         assert_eq!(events.len(), 1);
 901         match events[0] {
 902                 Event::PaymentSent { ref payment_preimage } => {
 903                         assert_eq!(our_payment_preimage, *payment_preimage);
 904                 },
 905                 _ => panic!("Unexpected event"),
 906         }
 907
 908         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 909         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 910         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 911         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 912         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 913         assert!(node_0_none.is_none());
 914
 915         assert!(nodes[0].node.list_channels().is_empty());
 916
 917         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 918         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 919         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 920         assert!(nodes[1].node.list_channels().is_empty());
 921         assert!(nodes[2].node.list_channels().is_empty());
 922 }
 923
 924 #[test]
 925 fn htlc_fail_async_shutdown() {
 926         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 927         let chanmon_cfgs = create_chanmon_cfgs(3);
 928         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 929         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 930         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 931         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 932         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 933         let logger = test_utils::TestLogger::new();
 934
 935         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
 936         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
 937         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 938         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
 939         check_added_monitors!(nodes[0], 1);
 940         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 941         assert_eq!(updates.update_add_htlcs.len(), 1);
 942         assert!(updates.update_fulfill_htlcs.is_empty());
 943         assert!(updates.update_fail_htlcs.is_empty());
 944         assert!(updates.update_fail_malformed_htlcs.is_empty());
 945         assert!(updates.update_fee.is_none());
 946
 947         nodes[1].node.close_channel(&chan_1.2).unwrap();
 948         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 949         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 950         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 951
 952         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 953         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 954         check_added_monitors!(nodes[1], 1);
 955         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 956         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 957
 958         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 959         assert!(updates_2.update_add_htlcs.is_empty());
 960         assert!(updates_2.update_fulfill_htlcs.is_empty());
 961         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 962         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 963         assert!(updates_2.update_fee.is_none());
 964
 965         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 966         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 967
 968         expect_payment_failed!(nodes[0], our_payment_hash, false);
 969
 970         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 971         assert_eq!(msg_events.len(), 2);
 972         let node_0_closing_signed = match msg_events[0] {
 973                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 974                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 975                         (*msg).clone()
 976                 },
 977                 _ => panic!("Unexpected event"),
 978         };
 979         match msg_events[1] {
 980                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 981                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 982                 },
 983                 _ => panic!("Unexpected event"),
 984         }
 985
 986         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 987         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 988         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 989         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 990         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 991         assert!(node_0_none.is_none());
 992
 993         assert!(nodes[0].node.list_channels().is_empty());
 994
 995         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 996         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 997         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 998         assert!(nodes[1].node.list_channels().is_empty());
 999         assert!(nodes[2].node.list_channels().is_empty());
1000 }
1001
1002 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1003         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1004         // messages delivered prior to disconnect
1005         let chanmon_cfgs = create_chanmon_cfgs(3);
1006         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1007         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1008         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1009         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1010         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1011
1012         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1013
1014         nodes[1].node.close_channel(&chan_1.2).unwrap();
1015         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1016         if recv_count > 0 {
1017                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
1018                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1019                 if recv_count > 1 {
1020                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
1021                 }
1022         }
1023
1024         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1025         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1026
1027         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1028         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1029         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1030         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1031
1032         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1033         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1034         assert!(node_1_shutdown == node_1_2nd_shutdown);
1035
1036         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1037         let node_0_2nd_shutdown = if recv_count > 0 {
1038                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1039                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1040                 node_0_2nd_shutdown
1041         } else {
1042                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1043                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1044                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1045         };
1046         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_2nd_shutdown);
1047
1048         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1049         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1050
1051         assert!(nodes[2].node.claim_funds(our_payment_preimage));
1052         check_added_monitors!(nodes[2], 1);
1053         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1054         assert!(updates.update_add_htlcs.is_empty());
1055         assert!(updates.update_fail_htlcs.is_empty());
1056         assert!(updates.update_fail_malformed_htlcs.is_empty());
1057         assert!(updates.update_fee.is_none());
1058         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1059         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1060         check_added_monitors!(nodes[1], 1);
1061         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1062         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1063
1064         assert!(updates_2.update_add_htlcs.is_empty());
1065         assert!(updates_2.update_fail_htlcs.is_empty());
1066         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1067         assert!(updates_2.update_fee.is_none());
1068         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1069         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1070         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1071
1072         let events = nodes[0].node.get_and_clear_pending_events();
1073         assert_eq!(events.len(), 1);
1074         match events[0] {
1075                 Event::PaymentSent { ref payment_preimage } => {
1076                         assert_eq!(our_payment_preimage, *payment_preimage);
1077                 },
1078                 _ => panic!("Unexpected event"),
1079         }
1080
1081         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1082         if recv_count > 0 {
1083                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1084                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1085                 assert!(node_1_closing_signed.is_some());
1086         }
1087
1088         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1089         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1090
1091         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1092         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1093         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1094         if recv_count == 0 {
1095                 // If all closing_signeds weren't delivered we can just resume where we left off...
1096                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1097
1098                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1099                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1100                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1101
1102                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1103                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1104                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1105
1106                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_3rd_shutdown);
1107                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1108
1109                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_3rd_shutdown);
1110                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1111                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1112
1113                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1114                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1115                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1116                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1117                 assert!(node_0_none.is_none());
1118         } else {
1119                 // If one node, however, received + responded with an identical closing_signed we end
1120                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1121                 // There isn't really anything better we can do simply, but in the future we might
1122                 // explore storing a set of recently-closed channels that got disconnected during
1123                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1124                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1125                 // transaction.
1126                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1127
1128                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1129                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1130                 assert_eq!(msg_events.len(), 1);
1131                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1132                         match action {
1133                                 &ErrorAction::SendErrorMessage { ref msg } => {
1134                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1135                                         assert_eq!(msg.channel_id, chan_1.2);
1136                                 },
1137                                 _ => panic!("Unexpected event!"),
1138                         }
1139                 } else { panic!("Needed SendErrorMessage close"); }
1140
1141                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1142                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1143                 // closing_signed so we do it ourselves
1144                 check_closed_broadcast!(nodes[0], false);
1145                 check_added_monitors!(nodes[0], 1);
1146         }
1147
1148         assert!(nodes[0].node.list_channels().is_empty());
1149
1150         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1151         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1152         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1153         assert!(nodes[1].node.list_channels().is_empty());
1154         assert!(nodes[2].node.list_channels().is_empty());
1155 }
1156
1157 #[test]
1158 fn test_shutdown_rebroadcast() {
1159         do_test_shutdown_rebroadcast(0);
1160         do_test_shutdown_rebroadcast(1);
1161         do_test_shutdown_rebroadcast(2);
1162 }
1163
1164 #[test]
1165 fn fake_network_test() {
1166         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1167         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1168         let chanmon_cfgs = create_chanmon_cfgs(4);
1169         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1170         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1171         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1172
1173         // Create some initial channels
1174         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1175         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1176         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1177
1178         // Rebalance the network a bit by relaying one payment through all the channels...
1179         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1180         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1181         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1182         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1183
1184         // Send some more payments
1185         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
1186         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
1187         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
1188
1189         // Test failure packets
1190         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1191         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1192
1193         // Add a new channel that skips 3
1194         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1195
1196         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
1197         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
1198         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1199         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1200         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1201         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1202         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1203
1204         // Do some rebalance loop payments, simultaneously
1205         let mut hops = Vec::with_capacity(3);
1206         hops.push(RouteHop {
1207                 pubkey: nodes[2].node.get_our_node_id(),
1208                 node_features: NodeFeatures::empty(),
1209                 short_channel_id: chan_2.0.contents.short_channel_id,
1210                 channel_features: ChannelFeatures::empty(),
1211                 fee_msat: 0,
1212                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1213         });
1214         hops.push(RouteHop {
1215                 pubkey: nodes[3].node.get_our_node_id(),
1216                 node_features: NodeFeatures::empty(),
1217                 short_channel_id: chan_3.0.contents.short_channel_id,
1218                 channel_features: ChannelFeatures::empty(),
1219                 fee_msat: 0,
1220                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1221         });
1222         hops.push(RouteHop {
1223                 pubkey: nodes[1].node.get_our_node_id(),
1224                 node_features: NodeFeatures::known(),
1225                 short_channel_id: chan_4.0.contents.short_channel_id,
1226                 channel_features: ChannelFeatures::known(),
1227                 fee_msat: 1000000,
1228                 cltv_expiry_delta: TEST_FINAL_CLTV,
1229         });
1230         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;
1231         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;
1232         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1233
1234         let mut hops = Vec::with_capacity(3);
1235         hops.push(RouteHop {
1236                 pubkey: nodes[3].node.get_our_node_id(),
1237                 node_features: NodeFeatures::empty(),
1238                 short_channel_id: chan_4.0.contents.short_channel_id,
1239                 channel_features: ChannelFeatures::empty(),
1240                 fee_msat: 0,
1241                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1242         });
1243         hops.push(RouteHop {
1244                 pubkey: nodes[2].node.get_our_node_id(),
1245                 node_features: NodeFeatures::empty(),
1246                 short_channel_id: chan_3.0.contents.short_channel_id,
1247                 channel_features: ChannelFeatures::empty(),
1248                 fee_msat: 0,
1249                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1250         });
1251         hops.push(RouteHop {
1252                 pubkey: nodes[1].node.get_our_node_id(),
1253                 node_features: NodeFeatures::known(),
1254                 short_channel_id: chan_2.0.contents.short_channel_id,
1255                 channel_features: ChannelFeatures::known(),
1256                 fee_msat: 1000000,
1257                 cltv_expiry_delta: TEST_FINAL_CLTV,
1258         });
1259         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;
1260         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;
1261         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1262
1263         // Claim the rebalances...
1264         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1265         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
1266
1267         // Add a duplicate new channel from 2 to 4
1268         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1269
1270         // Send some payments across both channels
1271         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1272         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1273         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1274
1275
1276         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1277         let events = nodes[0].node.get_and_clear_pending_msg_events();
1278         assert_eq!(events.len(), 0);
1279         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);
1280
1281         //TODO: Test that routes work again here as we've been notified that the channel is full
1282
1283         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
1284         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
1285         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
1286
1287         // Close down the channels...
1288         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1289         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1290         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1291         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1292         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1293 }
1294
1295 #[test]
1296 fn holding_cell_htlc_counting() {
1297         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1298         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1299         // commitment dance rounds.
1300         let chanmon_cfgs = create_chanmon_cfgs(3);
1301         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1302         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1303         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1304         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1305         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1306         let logger = test_utils::TestLogger::new();
1307
1308         let mut payments = Vec::new();
1309         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1310                 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
1311                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1312                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1313                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
1314                 payments.push((payment_preimage, payment_hash));
1315         }
1316         check_added_monitors!(nodes[1], 1);
1317
1318         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1319         assert_eq!(events.len(), 1);
1320         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1321         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1322
1323         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1324         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1325         // another HTLC.
1326         let (_, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[2]);
1327         {
1328                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1329                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1330                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable { ref err },
1331                         assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1332                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1333                 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1334         }
1335
1336         // This should also be true if we try to forward a payment.
1337         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[2]);
1338         {
1339                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1340                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1341                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1342                 check_added_monitors!(nodes[0], 1);
1343         }
1344
1345         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1346         assert_eq!(events.len(), 1);
1347         let payment_event = SendEvent::from_event(events.pop().unwrap());
1348         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1349
1350         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1351         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1352         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1353         // fails), the second will process the resulting failure and fail the HTLC backward.
1354         expect_pending_htlcs_forwardable!(nodes[1]);
1355         expect_pending_htlcs_forwardable!(nodes[1]);
1356         check_added_monitors!(nodes[1], 1);
1357
1358         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1359         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1360         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1361
1362         expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, false);
1363         expect_payment_failed!(nodes[0], payment_hash_2, false);
1364
1365         // Now forward all the pending HTLCs and claim them back
1366         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1367         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1368         check_added_monitors!(nodes[2], 1);
1369
1370         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1371         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1372         check_added_monitors!(nodes[1], 1);
1373         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1374
1375         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1376         check_added_monitors!(nodes[1], 1);
1377         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1378
1379         for ref update in as_updates.update_add_htlcs.iter() {
1380                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1381         }
1382         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1383         check_added_monitors!(nodes[2], 1);
1384         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1385         check_added_monitors!(nodes[2], 1);
1386         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1387
1388         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1389         check_added_monitors!(nodes[1], 1);
1390         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1391         check_added_monitors!(nodes[1], 1);
1392         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1393
1394         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1395         check_added_monitors!(nodes[2], 1);
1396
1397         expect_pending_htlcs_forwardable!(nodes[2]);
1398
1399         let events = nodes[2].node.get_and_clear_pending_events();
1400         assert_eq!(events.len(), payments.len());
1401         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1402                 match event {
1403                         &Event::PaymentReceived { ref payment_hash, .. } => {
1404                                 assert_eq!(*payment_hash, *hash);
1405                         },
1406                         _ => panic!("Unexpected event"),
1407                 };
1408         }
1409
1410         for (preimage, _) in payments.drain(..) {
1411                 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1412         }
1413
1414         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1415 }
1416
1417 #[test]
1418 fn duplicate_htlc_test() {
1419         // Test that we accept duplicate payment_hash HTLCs across the network and that
1420         // claiming/failing them are all separate and don't affect each other
1421         let chanmon_cfgs = create_chanmon_cfgs(6);
1422         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1423         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1424         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1425
1426         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1427         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1428         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1429         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1430         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1431         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1432
1433         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1434
1435         *nodes[0].network_payment_count.borrow_mut() -= 1;
1436         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1437
1438         *nodes[0].network_payment_count.borrow_mut() -= 1;
1439         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1440
1441         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1442         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1443         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1444 }
1445
1446 #[test]
1447 fn test_duplicate_htlc_different_direction_onchain() {
1448         // Test that ChannelMonitor doesn't generate 2 preimage txn
1449         // when we have 2 HTLCs with same preimage that go across a node
1450         // in opposite directions, even with the same payment secret.
1451         let chanmon_cfgs = create_chanmon_cfgs(2);
1452         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1453         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1454         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1455
1456         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1457         let logger = test_utils::TestLogger::new();
1458
1459         // balancing
1460         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1461
1462         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1463
1464         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1465         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 800_000, TEST_FINAL_CLTV, &logger).unwrap();
1466         let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
1467         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1468
1469         // Provide preimage to node 0 by claiming payment
1470         nodes[0].node.claim_funds(payment_preimage);
1471         check_added_monitors!(nodes[0], 1);
1472
1473         // Broadcast node 1 commitment txn
1474         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1475
1476         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1477         let mut has_both_htlcs = 0; // check htlcs match ones committed
1478         for outp in remote_txn[0].output.iter() {
1479                 if outp.value == 800_000 / 1000 {
1480                         has_both_htlcs += 1;
1481                 } else if outp.value == 900_000 / 1000 {
1482                         has_both_htlcs += 1;
1483                 }
1484         }
1485         assert_eq!(has_both_htlcs, 2);
1486
1487         mine_transaction(&nodes[0], &remote_txn[0]);
1488         check_added_monitors!(nodes[0], 1);
1489         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
1490
1491         // Check we only broadcast 1 timeout tx
1492         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1493         assert_eq!(claim_txn.len(), 8);
1494         assert_eq!(claim_txn[1], claim_txn[4]);
1495         assert_eq!(claim_txn[2], claim_txn[5]);
1496         check_spends!(claim_txn[1], chan_1.3);
1497         check_spends!(claim_txn[2], claim_txn[1]);
1498         check_spends!(claim_txn[7], claim_txn[1]);
1499
1500         assert_eq!(claim_txn[0].input.len(), 1);
1501         assert_eq!(claim_txn[3].input.len(), 1);
1502         assert_eq!(claim_txn[0].input[0].previous_output, claim_txn[3].input[0].previous_output);
1503
1504         assert_eq!(claim_txn[0].input.len(), 1);
1505         assert_eq!(claim_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1506         check_spends!(claim_txn[0], remote_txn[0]);
1507         assert_eq!(remote_txn[0].output[claim_txn[0].input[0].previous_output.vout as usize].value, 800);
1508         assert_eq!(claim_txn[6].input.len(), 1);
1509         assert_eq!(claim_txn[6].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1510         check_spends!(claim_txn[6], remote_txn[0]);
1511         assert_eq!(remote_txn[0].output[claim_txn[6].input[0].previous_output.vout as usize].value, 900);
1512
1513         let events = nodes[0].node.get_and_clear_pending_msg_events();
1514         assert_eq!(events.len(), 3);
1515         for e in events {
1516                 match e {
1517                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1518                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1519                                 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1520                                 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1521                         },
1522                         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, .. } } => {
1523                                 assert!(update_add_htlcs.is_empty());
1524                                 assert!(update_fail_htlcs.is_empty());
1525                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1526                                 assert!(update_fail_malformed_htlcs.is_empty());
1527                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1528                         },
1529                         _ => panic!("Unexpected event"),
1530                 }
1531         }
1532 }
1533
1534 #[test]
1535 fn test_basic_channel_reserve() {
1536         let chanmon_cfgs = create_chanmon_cfgs(2);
1537         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1538         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1539         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1540         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1541         let logger = test_utils::TestLogger::new();
1542
1543         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1544         let channel_reserve = chan_stat.channel_reserve_msat;
1545
1546         // The 2* and +1 are for the fee spike reserve.
1547         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
1548         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1549         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1550         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1551         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1552         let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).err().unwrap();
1553         match err {
1554                 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1555                         match &fails[0] {
1556                                 &APIError::ChannelUnavailable{ref err} =>
1557                                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1558                                 _ => panic!("Unexpected error variant"),
1559                         }
1560                 },
1561                 _ => panic!("Unexpected error variant"),
1562         }
1563         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1564         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);
1565
1566         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1567 }
1568
1569 #[test]
1570 fn test_fee_spike_violation_fails_htlc() {
1571         let chanmon_cfgs = create_chanmon_cfgs(2);
1572         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1573         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1574         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1575         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1576
1577         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1578         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1579         let secp_ctx = Secp256k1::new();
1580         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1581
1582         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1583
1584         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1585         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height).unwrap();
1586         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1587         let msg = msgs::UpdateAddHTLC {
1588                 channel_id: chan.2,
1589                 htlc_id: 0,
1590                 amount_msat: htlc_msat,
1591                 payment_hash: payment_hash,
1592                 cltv_expiry: htlc_cltv,
1593                 onion_routing_packet: onion_packet,
1594         };
1595
1596         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1597
1598         // Now manually create the commitment_signed message corresponding to the update_add
1599         // nodes[0] just sent. In the code for construction of this message, "local" refers
1600         // to the sender of the message, and "remote" refers to the receiver.
1601
1602         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1603
1604         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1605
1606         // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1607         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1608         let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point) = {
1609                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1610                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1611                 let chan_signer = local_chan.get_signer();
1612                 let pubkeys = chan_signer.pubkeys();
1613                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1614                  chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1615                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx))
1616         };
1617         let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point) = {
1618                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1619                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1620                 let chan_signer = remote_chan.get_signer();
1621                 let pubkeys = chan_signer.pubkeys();
1622                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1623                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx))
1624         };
1625
1626         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1627         let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1628                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1629
1630         // Build the remote commitment transaction so we can sign it, and then later use the
1631         // signature for the commitment_signed message.
1632         let local_chan_balance = 1313;
1633
1634         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1635                 offered: false,
1636                 amount_msat: 3460001,
1637                 cltv_expiry: htlc_cltv,
1638                 payment_hash,
1639                 transaction_output_index: Some(1),
1640         };
1641
1642         let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1643
1644         let res = {
1645                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1646                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1647                 let local_chan_signer = local_chan.get_signer();
1648                 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1649                         commitment_number,
1650                         95000,
1651                         local_chan_balance,
1652                         commit_tx_keys.clone(),
1653                         feerate_per_kw,
1654                         &mut vec![(accepted_htlc_info, ())],
1655                         &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1656                 );
1657                 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1658         };
1659
1660         let commit_signed_msg = msgs::CommitmentSigned {
1661                 channel_id: chan.2,
1662                 signature: res.0,
1663                 htlc_signatures: res.1
1664         };
1665
1666         // Send the commitment_signed message to the nodes[1].
1667         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1668         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1669
1670         // Send the RAA to nodes[1].
1671         let raa_msg = msgs::RevokeAndACK {
1672                 channel_id: chan.2,
1673                 per_commitment_secret: local_secret,
1674                 next_per_commitment_point: next_local_point
1675         };
1676         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1677
1678         let events = nodes[1].node.get_and_clear_pending_msg_events();
1679         assert_eq!(events.len(), 1);
1680         // Make sure the HTLC failed in the way we expect.
1681         match events[0] {
1682                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1683                         assert_eq!(update_fail_htlcs.len(), 1);
1684                         update_fail_htlcs[0].clone()
1685                 },
1686                 _ => panic!("Unexpected event"),
1687         };
1688         nodes[1].logger.assert_log("lightning::ln::channel".to_string(),
1689                 format!("Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", ::hex::encode(raa_msg.channel_id)), 1);
1690
1691         check_added_monitors!(nodes[1], 2);
1692 }
1693
1694 #[test]
1695 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1696         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1697         // Set the fee rate for the channel very high, to the point where the fundee
1698         // sending any above-dust amount would result in a channel reserve violation.
1699         // In this test we check that we would be prevented from sending an HTLC in
1700         // this situation.
1701         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1702         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1703         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1704         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1705         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1706         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1707
1708         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 4843000);
1709         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1710                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1711         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1712         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);
1713 }
1714
1715 #[test]
1716 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1717         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1718         // Set the fee rate for the channel very high, to the point where the funder
1719         // receiving 1 update_add_htlc would result in them closing the channel due
1720         // to channel reserve violation. This close could also happen if the fee went
1721         // up a more realistic amount, but many HTLCs were outstanding at the time of
1722         // the update_add_htlc.
1723         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1724         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1725         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1726         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1727         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1728         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1729
1730         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1731         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1732         let secp_ctx = Secp256k1::new();
1733         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1734         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1735         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1736         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height).unwrap();
1737         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1738         let msg = msgs::UpdateAddHTLC {
1739                 channel_id: chan.2,
1740                 htlc_id: 1,
1741                 amount_msat: htlc_msat + 1,
1742                 payment_hash: payment_hash,
1743                 cltv_expiry: htlc_cltv,
1744                 onion_routing_packet: onion_packet,
1745         };
1746
1747         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1748         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1749         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);
1750         assert_eq!(nodes[0].node.list_channels().len(), 0);
1751         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1752         assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1753         check_added_monitors!(nodes[0], 1);
1754 }
1755
1756 #[test]
1757 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1758         // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1759         // calculating our commitment transaction fee (this was previously broken).
1760         let chanmon_cfgs = create_chanmon_cfgs(2);
1761         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1762         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1763         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1764
1765         // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1766         // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1767         // transaction fee with 0 HTLCs (183 sats)).
1768         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98817000, InitFeatures::known(), InitFeatures::known());
1769
1770         let dust_amt = 329000; // Dust amount
1771         // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1772         // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1773         // commitment transaction fee.
1774         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1775 }
1776
1777 #[test]
1778 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1779         // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1780         // calculating our counterparty's commitment transaction fee (this was previously broken).
1781         let chanmon_cfgs = create_chanmon_cfgs(2);
1782         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1783         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1784         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1785         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1786
1787         let payment_amt = 46000; // Dust amount
1788         // In the previous code, these first four payments would succeed.
1789         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1790         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1791         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1792         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1793
1794         // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1795         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1796         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1797         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1798         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1799         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1800
1801         // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1802         // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1803         // transaction fee and therefore perceived this next payment as a channel reserve violation.
1804         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1805 }
1806
1807 #[test]
1808 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1809         let chanmon_cfgs = create_chanmon_cfgs(3);
1810         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1811         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1812         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1813         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1814         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1815
1816         let feemsat = 239;
1817         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1818         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1819         let feerate = get_feerate!(nodes[0], chan.2);
1820
1821         // Add a 2* and +1 for the fee spike reserve.
1822         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1823         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;
1824         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1825
1826         // Add a pending HTLC.
1827         let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1828         let payment_event_1 = {
1829                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1830                 check_added_monitors!(nodes[0], 1);
1831
1832                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1833                 assert_eq!(events.len(), 1);
1834                 SendEvent::from_event(events.remove(0))
1835         };
1836         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1837
1838         // Attempt to trigger a channel reserve violation --> payment failure.
1839         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1840         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;
1841         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1842         let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1843
1844         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1845         let secp_ctx = Secp256k1::new();
1846         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1847         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1848         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1849         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1850         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1851         let msg = msgs::UpdateAddHTLC {
1852                 channel_id: chan.2,
1853                 htlc_id: 1,
1854                 amount_msat: htlc_msat + 1,
1855                 payment_hash: our_payment_hash_1,
1856                 cltv_expiry: htlc_cltv,
1857                 onion_routing_packet: onion_packet,
1858         };
1859
1860         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1861         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1862         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1863         assert_eq!(nodes[1].node.list_channels().len(), 1);
1864         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1865         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1866         check_added_monitors!(nodes[1], 1);
1867 }
1868
1869 #[test]
1870 fn test_inbound_outbound_capacity_is_not_zero() {
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 nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1875         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1876         let channels0 = node_chanmgrs[0].list_channels();
1877         let channels1 = node_chanmgrs[1].list_channels();
1878         assert_eq!(channels0.len(), 1);
1879         assert_eq!(channels1.len(), 1);
1880
1881         assert_eq!(channels0[0].inbound_capacity_msat, 95000000);
1882         assert_eq!(channels1[0].outbound_capacity_msat, 95000000);
1883
1884         assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000);
1885         assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000);
1886 }
1887
1888 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1889         (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1890 }
1891
1892 #[test]
1893 fn test_channel_reserve_holding_cell_htlcs() {
1894         let chanmon_cfgs = create_chanmon_cfgs(3);
1895         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1896         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1897         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1898         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1899         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1900
1901         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1902         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1903
1904         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1905         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1906
1907         macro_rules! expect_forward {
1908                 ($node: expr) => {{
1909                         let mut events = $node.node.get_and_clear_pending_msg_events();
1910                         assert_eq!(events.len(), 1);
1911                         check_added_monitors!($node, 1);
1912                         let payment_event = SendEvent::from_event(events.remove(0));
1913                         payment_event
1914                 }}
1915         }
1916
1917         let feemsat = 239; // somehow we know?
1918         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1919         let feerate = get_feerate!(nodes[0], chan_1.2);
1920
1921         let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1922
1923         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1924         {
1925                 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1926                 route.paths[0].last_mut().unwrap().fee_msat += 1;
1927                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1928                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1929                         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)));
1930                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1931                 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);
1932         }
1933
1934         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1935         // nodes[0]'s wealth
1936         loop {
1937                 let amt_msat = recv_value_0 + total_fee_msat;
1938                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1939                 // Also, ensure that each payment has enough to be over the dust limit to
1940                 // ensure it'll be included in each commit tx fee calculation.
1941                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1942                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1943                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1944                         break;
1945                 }
1946                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1947
1948                 let (stat01_, stat11_, stat12_, stat22_) = (
1949                         get_channel_value_stat!(nodes[0], chan_1.2),
1950                         get_channel_value_stat!(nodes[1], chan_1.2),
1951                         get_channel_value_stat!(nodes[1], chan_2.2),
1952                         get_channel_value_stat!(nodes[2], chan_2.2),
1953                 );
1954
1955                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1956                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1957                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1958                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1959                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1960         }
1961
1962         // adding pending output.
1963         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1964         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1965         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1966         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1967         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1968         // cases where 1 msat over X amount will cause a payment failure, but anything less than
1969         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1970         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1971         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1972         // policy.
1973         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1974         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1975         let amt_msat_1 = recv_value_1 + total_fee_msat;
1976
1977         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);
1978         let payment_event_1 = {
1979                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1980                 check_added_monitors!(nodes[0], 1);
1981
1982                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1983                 assert_eq!(events.len(), 1);
1984                 SendEvent::from_event(events.remove(0))
1985         };
1986         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1987
1988         // channel reserve test with htlc pending output > 0
1989         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1990         {
1991                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
1992                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1993                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1994                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1995         }
1996
1997         // split the rest to test holding cell
1998         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1999         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2000         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2001         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2002         {
2003                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2004                 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);
2005         }
2006
2007         // now see if they go through on both sides
2008         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);
2009         // but this will stuck in the holding cell
2010         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
2011         check_added_monitors!(nodes[0], 0);
2012         let events = nodes[0].node.get_and_clear_pending_events();
2013         assert_eq!(events.len(), 0);
2014
2015         // test with outbound holding cell amount > 0
2016         {
2017                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
2018                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2019                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2020                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2021                 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);
2022         }
2023
2024         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);
2025         // this will also stuck in the holding cell
2026         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
2027         check_added_monitors!(nodes[0], 0);
2028         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2029         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2030
2031         // flush the pending htlc
2032         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2033         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2034         check_added_monitors!(nodes[1], 1);
2035
2036         // the pending htlc should be promoted to committed
2037         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2038         check_added_monitors!(nodes[0], 1);
2039         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2040
2041         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2042         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2043         // No commitment_signed so get_event_msg's assert(len == 1) passes
2044         check_added_monitors!(nodes[0], 1);
2045
2046         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2047         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2048         check_added_monitors!(nodes[1], 1);
2049
2050         expect_pending_htlcs_forwardable!(nodes[1]);
2051
2052         let ref payment_event_11 = expect_forward!(nodes[1]);
2053         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2054         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2055
2056         expect_pending_htlcs_forwardable!(nodes[2]);
2057         expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
2058
2059         // flush the htlcs in the holding cell
2060         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2061         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2062         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2063         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2064         expect_pending_htlcs_forwardable!(nodes[1]);
2065
2066         let ref payment_event_3 = expect_forward!(nodes[1]);
2067         assert_eq!(payment_event_3.msgs.len(), 2);
2068         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2069         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2070
2071         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2072         expect_pending_htlcs_forwardable!(nodes[2]);
2073
2074         let events = nodes[2].node.get_and_clear_pending_events();
2075         assert_eq!(events.len(), 2);
2076         match events[0] {
2077                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2078                         assert_eq!(our_payment_hash_21, *payment_hash);
2079                         assert!(payment_preimage.is_none());
2080                         assert_eq!(our_payment_secret_21, *payment_secret);
2081                         assert_eq!(recv_value_21, amt);
2082                 },
2083                 _ => panic!("Unexpected event"),
2084         }
2085         match events[1] {
2086                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2087                         assert_eq!(our_payment_hash_22, *payment_hash);
2088                         assert!(payment_preimage.is_none());
2089                         assert_eq!(our_payment_secret_22, *payment_secret);
2090                         assert_eq!(recv_value_22, amt);
2091                 },
2092                 _ => panic!("Unexpected event"),
2093         }
2094
2095         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
2096         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
2097         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
2098
2099         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2100         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2101         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
2102
2103         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2104         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);
2105         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2106         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2107         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2108
2109         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2110         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2111 }
2112
2113 #[test]
2114 fn channel_reserve_in_flight_removes() {
2115         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2116         // can send to its counterparty, but due to update ordering, the other side may not yet have
2117         // considered those HTLCs fully removed.
2118         // This tests that we don't count HTLCs which will not be included in the next remote
2119         // commitment transaction towards the reserve value (as it implies no commitment transaction
2120         // will be generated which violates the remote reserve value).
2121         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2122         // To test this we:
2123         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2124         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2125         //    you only consider the value of the first HTLC, it may not),
2126         //  * start routing a third HTLC from A to B,
2127         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2128         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2129         //  * deliver the first fulfill from B
2130         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2131         //    claim,
2132         //  * deliver A's response CS and RAA.
2133         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2134         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
2135         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2136         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2137         let chanmon_cfgs = create_chanmon_cfgs(2);
2138         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2139         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2140         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2141         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2142         let logger = test_utils::TestLogger::new();
2143
2144         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2145         // Route the first two HTLCs.
2146         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2147         let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2148
2149         // Start routing the third HTLC (this is just used to get everyone in the right state).
2150         let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
2151         let send_1 = {
2152                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2153                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
2154                 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
2155                 check_added_monitors!(nodes[0], 1);
2156                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2157                 assert_eq!(events.len(), 1);
2158                 SendEvent::from_event(events.remove(0))
2159         };
2160
2161         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2162         // initial fulfill/CS.
2163         assert!(nodes[1].node.claim_funds(payment_preimage_1));
2164         check_added_monitors!(nodes[1], 1);
2165         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2166
2167         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2168         // remove the second HTLC when we send the HTLC back from B to A.
2169         assert!(nodes[1].node.claim_funds(payment_preimage_2));
2170         check_added_monitors!(nodes[1], 1);
2171         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2172
2173         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2174         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2175         check_added_monitors!(nodes[0], 1);
2176         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2177         expect_payment_sent!(nodes[0], payment_preimage_1);
2178
2179         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2180         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2181         check_added_monitors!(nodes[1], 1);
2182         // B is already AwaitingRAA, so cant generate a CS here
2183         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2184
2185         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2186         check_added_monitors!(nodes[1], 1);
2187         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2188
2189         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2190         check_added_monitors!(nodes[0], 1);
2191         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2192
2193         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2194         check_added_monitors!(nodes[1], 1);
2195         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2196
2197         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2198         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2199         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2200         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2201         // on-chain as necessary).
2202         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2203         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2204         check_added_monitors!(nodes[0], 1);
2205         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2206         expect_payment_sent!(nodes[0], payment_preimage_2);
2207
2208         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2209         check_added_monitors!(nodes[1], 1);
2210         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2211
2212         expect_pending_htlcs_forwardable!(nodes[1]);
2213         expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
2214
2215         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2216         // resolve the second HTLC from A's point of view.
2217         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2218         check_added_monitors!(nodes[0], 1);
2219         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2220
2221         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2222         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2223         let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
2224         let send_2 = {
2225                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2226                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 10000, TEST_FINAL_CLTV, &logger).unwrap();
2227                 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
2228                 check_added_monitors!(nodes[1], 1);
2229                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2230                 assert_eq!(events.len(), 1);
2231                 SendEvent::from_event(events.remove(0))
2232         };
2233
2234         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2235         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2236         check_added_monitors!(nodes[0], 1);
2237         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2238
2239         // Now just resolve all the outstanding messages/HTLCs for completeness...
2240
2241         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2242         check_added_monitors!(nodes[1], 1);
2243         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2244
2245         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2246         check_added_monitors!(nodes[1], 1);
2247
2248         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2249         check_added_monitors!(nodes[0], 1);
2250         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2251
2252         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2253         check_added_monitors!(nodes[1], 1);
2254         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2255
2256         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2257         check_added_monitors!(nodes[0], 1);
2258
2259         expect_pending_htlcs_forwardable!(nodes[0]);
2260         expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2261
2262         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2263         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2264 }
2265
2266 #[test]
2267 fn channel_monitor_network_test() {
2268         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2269         // tests that ChannelMonitor is able to recover from various states.
2270         let chanmon_cfgs = create_chanmon_cfgs(5);
2271         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2272         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2273         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2274
2275         // Create some initial channels
2276         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2277         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2278         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2279         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2280
2281         // Make sure all nodes are at the same starting height
2282         connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2283         connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2284         connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2285         connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2286         connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2287
2288         // Rebalance the network a bit by relaying one payment through all the channels...
2289         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2290         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2291         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2292         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2293
2294         // Simple case with no pending HTLCs:
2295         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2296         check_added_monitors!(nodes[1], 1);
2297         check_closed_broadcast!(nodes[1], false);
2298         {
2299                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2300                 assert_eq!(node_txn.len(), 1);
2301                 mine_transaction(&nodes[0], &node_txn[0]);
2302                 check_added_monitors!(nodes[0], 1);
2303                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2304         }
2305         check_closed_broadcast!(nodes[0], true);
2306         assert_eq!(nodes[0].node.list_channels().len(), 0);
2307         assert_eq!(nodes[1].node.list_channels().len(), 1);
2308
2309         // One pending HTLC is discarded by the force-close:
2310         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2311
2312         // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2313         // broadcasted until we reach the timelock time).
2314         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2315         check_closed_broadcast!(nodes[1], false);
2316         check_added_monitors!(nodes[1], 1);
2317         {
2318                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2319                 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2320                 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2321                 mine_transaction(&nodes[2], &node_txn[0]);
2322                 check_added_monitors!(nodes[2], 1);
2323                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2324         }
2325         check_closed_broadcast!(nodes[2], true);
2326         assert_eq!(nodes[1].node.list_channels().len(), 0);
2327         assert_eq!(nodes[2].node.list_channels().len(), 1);
2328
2329         macro_rules! claim_funds {
2330                 ($node: expr, $prev_node: expr, $preimage: expr) => {
2331                         {
2332                                 assert!($node.node.claim_funds($preimage));
2333                                 check_added_monitors!($node, 1);
2334
2335                                 let events = $node.node.get_and_clear_pending_msg_events();
2336                                 assert_eq!(events.len(), 1);
2337                                 match events[0] {
2338                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2339                                                 assert!(update_add_htlcs.is_empty());
2340                                                 assert!(update_fail_htlcs.is_empty());
2341                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2342                                         },
2343                                         _ => panic!("Unexpected event"),
2344                                 };
2345                         }
2346                 }
2347         }
2348
2349         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2350         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2351         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2352         check_added_monitors!(nodes[2], 1);
2353         check_closed_broadcast!(nodes[2], false);
2354         let node2_commitment_txid;
2355         {
2356                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2357                 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2358                 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2359                 node2_commitment_txid = node_txn[0].txid();
2360
2361                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2362                 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2363                 mine_transaction(&nodes[3], &node_txn[0]);
2364                 check_added_monitors!(nodes[3], 1);
2365                 check_preimage_claim(&nodes[3], &node_txn);
2366         }
2367         check_closed_broadcast!(nodes[3], true);
2368         assert_eq!(nodes[2].node.list_channels().len(), 0);
2369         assert_eq!(nodes[3].node.list_channels().len(), 1);
2370
2371         // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2372         // confusing us in the following tests.
2373         let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2374
2375         // One pending HTLC to time out:
2376         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2377         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2378         // buffer space).
2379
2380         let (close_chan_update_1, close_chan_update_2) = {
2381                 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2382                 let events = nodes[3].node.get_and_clear_pending_msg_events();
2383                 assert_eq!(events.len(), 2);
2384                 let close_chan_update_1 = match events[0] {
2385                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2386                                 msg.clone()
2387                         },
2388                         _ => panic!("Unexpected event"),
2389                 };
2390                 match events[1] {
2391                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2392                                 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2393                         },
2394                         _ => panic!("Unexpected event"),
2395                 }
2396                 check_added_monitors!(nodes[3], 1);
2397
2398                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2399                 {
2400                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2401                         node_txn.retain(|tx| {
2402                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2403                                         false
2404                                 } else { true }
2405                         });
2406                 }
2407
2408                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2409
2410                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2411                 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2412
2413                 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2414                 let events = nodes[4].node.get_and_clear_pending_msg_events();
2415                 assert_eq!(events.len(), 2);
2416                 let close_chan_update_2 = match events[0] {
2417                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2418                                 msg.clone()
2419                         },
2420                         _ => panic!("Unexpected event"),
2421                 };
2422                 match events[1] {
2423                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2424                                 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2425                         },
2426                         _ => panic!("Unexpected event"),
2427                 }
2428                 check_added_monitors!(nodes[4], 1);
2429                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2430
2431                 mine_transaction(&nodes[4], &node_txn[0]);
2432                 check_preimage_claim(&nodes[4], &node_txn);
2433                 (close_chan_update_1, close_chan_update_2)
2434         };
2435         nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2436         nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2437         assert_eq!(nodes[3].node.list_channels().len(), 0);
2438         assert_eq!(nodes[4].node.list_channels().len(), 0);
2439
2440         nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2441 }
2442
2443 #[test]
2444 fn test_justice_tx() {
2445         // Test justice txn built on revoked HTLC-Success tx, against both sides
2446         let mut alice_config = UserConfig::default();
2447         alice_config.channel_options.announced_channel = true;
2448         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2449         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2450         let mut bob_config = UserConfig::default();
2451         bob_config.channel_options.announced_channel = true;
2452         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2453         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2454         let user_cfgs = [Some(alice_config), Some(bob_config)];
2455         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2456         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2457         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2458         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2459         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2460         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2461         // Create some new channels:
2462         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2463
2464         // A pending HTLC which will be revoked:
2465         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2466         // Get the will-be-revoked local txn from nodes[0]
2467         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2468         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2469         assert_eq!(revoked_local_txn[0].input.len(), 1);
2470         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2471         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2472         assert_eq!(revoked_local_txn[1].input.len(), 1);
2473         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2474         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2475         // Revoke the old state
2476         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2477
2478         {
2479                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2480                 {
2481                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2482                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2483                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2484
2485                         check_spends!(node_txn[0], revoked_local_txn[0]);
2486                         node_txn.swap_remove(0);
2487                         node_txn.truncate(1);
2488                 }
2489                 check_added_monitors!(nodes[1], 1);
2490                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2491
2492                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2493                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2494                 // Verify broadcast of revoked HTLC-timeout
2495                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2496                 check_added_monitors!(nodes[0], 1);
2497                 // Broadcast revoked HTLC-timeout on node 1
2498                 mine_transaction(&nodes[1], &node_txn[1]);
2499                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2500         }
2501         get_announce_close_broadcast_events(&nodes, 0, 1);
2502
2503         assert_eq!(nodes[0].node.list_channels().len(), 0);
2504         assert_eq!(nodes[1].node.list_channels().len(), 0);
2505
2506         // We test justice_tx build by A on B's revoked HTLC-Success tx
2507         // Create some new channels:
2508         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2509         {
2510                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2511                 node_txn.clear();
2512         }
2513
2514         // A pending HTLC which will be revoked:
2515         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2516         // Get the will-be-revoked local txn from B
2517         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2518         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2519         assert_eq!(revoked_local_txn[0].input.len(), 1);
2520         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2521         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2522         // Revoke the old state
2523         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2524         {
2525                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2526                 {
2527                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2528                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2529                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2530
2531                         check_spends!(node_txn[0], revoked_local_txn[0]);
2532                         node_txn.swap_remove(0);
2533                 }
2534                 check_added_monitors!(nodes[0], 1);
2535                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2536
2537                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2538                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2539                 check_added_monitors!(nodes[1], 1);
2540                 mine_transaction(&nodes[0], &node_txn[1]);
2541                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2542         }
2543         get_announce_close_broadcast_events(&nodes, 0, 1);
2544         assert_eq!(nodes[0].node.list_channels().len(), 0);
2545         assert_eq!(nodes[1].node.list_channels().len(), 0);
2546 }
2547
2548 #[test]
2549 fn revoked_output_claim() {
2550         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2551         // transaction is broadcast by its counterparty
2552         let chanmon_cfgs = create_chanmon_cfgs(2);
2553         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2554         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2555         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2556         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2557         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2558         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2559         assert_eq!(revoked_local_txn.len(), 1);
2560         // Only output is the full channel value back to nodes[0]:
2561         assert_eq!(revoked_local_txn[0].output.len(), 1);
2562         // Send a payment through, updating everyone's latest commitment txn
2563         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2564
2565         // Inform nodes[1] that nodes[0] broadcast a stale tx
2566         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2567         check_added_monitors!(nodes[1], 1);
2568         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2569         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2570
2571         check_spends!(node_txn[0], revoked_local_txn[0]);
2572         check_spends!(node_txn[1], chan_1.3);
2573
2574         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2575         mine_transaction(&nodes[0], &revoked_local_txn[0]);
2576         get_announce_close_broadcast_events(&nodes, 0, 1);
2577         check_added_monitors!(nodes[0], 1)
2578 }
2579
2580 #[test]
2581 fn claim_htlc_outputs_shared_tx() {
2582         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2583         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2584         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2585         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2586         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2587         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2588
2589         // Create some new channel:
2590         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2591
2592         // Rebalance the network to generate htlc in the two directions
2593         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2594         // 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
2595         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2596         let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2597
2598         // Get the will-be-revoked local txn from node[0]
2599         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2600         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2601         assert_eq!(revoked_local_txn[0].input.len(), 1);
2602         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2603         assert_eq!(revoked_local_txn[1].input.len(), 1);
2604         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2605         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2606         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2607
2608         //Revoke the old state
2609         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2610
2611         {
2612                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2613                 check_added_monitors!(nodes[0], 1);
2614                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2615                 check_added_monitors!(nodes[1], 1);
2616                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2617                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2618
2619                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2620                 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment
2621
2622                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2623                 check_spends!(node_txn[0], revoked_local_txn[0]);
2624
2625                 let mut witness_lens = BTreeSet::new();
2626                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2627                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2628                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2629                 assert_eq!(witness_lens.len(), 3);
2630                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2631                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2632                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2633
2634                 // Next nodes[1] broadcasts its current local tx state:
2635                 assert_eq!(node_txn[1].input.len(), 1);
2636                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2637         }
2638         get_announce_close_broadcast_events(&nodes, 0, 1);
2639         assert_eq!(nodes[0].node.list_channels().len(), 0);
2640         assert_eq!(nodes[1].node.list_channels().len(), 0);
2641 }
2642
2643 #[test]
2644 fn claim_htlc_outputs_single_tx() {
2645         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2646         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2647         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2648         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2649         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2650         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2651
2652         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2653
2654         // Rebalance the network to generate htlc in the two directions
2655         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2656         // 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
2657         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2658         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2659         let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2660
2661         // Get the will-be-revoked local txn from node[0]
2662         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2663
2664         //Revoke the old state
2665         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2666
2667         {
2668                 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2669                 check_added_monitors!(nodes[0], 1);
2670                 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2671                 check_added_monitors!(nodes[1], 1);
2672                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2673
2674                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2675                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2676
2677                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2678                 assert_eq!(node_txn.len(), 9);
2679                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2680                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2681                 // 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)
2682                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2683
2684                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2685                 assert_eq!(node_txn[0].input.len(), 1);
2686                 check_spends!(node_txn[0], chan_1.3);
2687                 assert_eq!(node_txn[1].input.len(), 1);
2688                 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2689                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2690                 check_spends!(node_txn[1], node_txn[0]);
2691
2692                 // Justice transactions are indices 1-2-4
2693                 assert_eq!(node_txn[2].input.len(), 1);
2694                 assert_eq!(node_txn[3].input.len(), 1);
2695                 assert_eq!(node_txn[4].input.len(), 1);
2696
2697                 check_spends!(node_txn[2], revoked_local_txn[0]);
2698                 check_spends!(node_txn[3], revoked_local_txn[0]);
2699                 check_spends!(node_txn[4], revoked_local_txn[0]);
2700
2701                 let mut witness_lens = BTreeSet::new();
2702                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2703                 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2704                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2705                 assert_eq!(witness_lens.len(), 3);
2706                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2707                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2708                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2709         }
2710         get_announce_close_broadcast_events(&nodes, 0, 1);
2711         assert_eq!(nodes[0].node.list_channels().len(), 0);
2712         assert_eq!(nodes[1].node.list_channels().len(), 0);
2713 }
2714
2715 #[test]
2716 fn test_htlc_on_chain_success() {
2717         // Test that in case of a unilateral close onchain, we detect the state of output and pass
2718         // the preimage backward accordingly. So here we test that ChannelManager is
2719         // broadcasting the right event to other nodes in payment path.
2720         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2721         // A --------------------> B ----------------------> C (preimage)
2722         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2723         // commitment transaction was broadcast.
2724         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2725         // towards B.
2726         // B should be able to claim via preimage if A then broadcasts its local tx.
2727         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2728         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2729         // PaymentSent event).
2730
2731         let chanmon_cfgs = create_chanmon_cfgs(3);
2732         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2733         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2734         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2735
2736         // Create some initial channels
2737         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2738         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2739
2740         // Ensure all nodes are at the same height
2741         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2742         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2743         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2744         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2745
2746         // Rebalance the network a bit by relaying one payment through all the channels...
2747         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2748         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2749
2750         let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2751         let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2752
2753         // Broadcast legit commitment tx from C on B's chain
2754         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2755         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2756         assert_eq!(commitment_tx.len(), 1);
2757         check_spends!(commitment_tx[0], chan_2.3);
2758         nodes[2].node.claim_funds(our_payment_preimage);
2759         nodes[2].node.claim_funds(our_payment_preimage_2);
2760         check_added_monitors!(nodes[2], 2);
2761         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2762         assert!(updates.update_add_htlcs.is_empty());
2763         assert!(updates.update_fail_htlcs.is_empty());
2764         assert!(updates.update_fail_malformed_htlcs.is_empty());
2765         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2766
2767         mine_transaction(&nodes[2], &commitment_tx[0]);
2768         check_closed_broadcast!(nodes[2], true);
2769         check_added_monitors!(nodes[2], 1);
2770         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)
2771         assert_eq!(node_txn.len(), 5);
2772         assert_eq!(node_txn[0], node_txn[3]);
2773         assert_eq!(node_txn[1], node_txn[4]);
2774         assert_eq!(node_txn[2], commitment_tx[0]);
2775         check_spends!(node_txn[0], commitment_tx[0]);
2776         check_spends!(node_txn[1], commitment_tx[0]);
2777         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2778         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2779         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2780         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2781         assert_eq!(node_txn[0].lock_time, 0);
2782         assert_eq!(node_txn[1].lock_time, 0);
2783
2784         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2785         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2786         connect_block(&nodes[1], &Block { header, txdata: node_txn});
2787         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2788         {
2789                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2790                 assert_eq!(added_monitors.len(), 1);
2791                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2792                 added_monitors.clear();
2793         }
2794         let events = nodes[1].node.get_and_clear_pending_msg_events();
2795         {
2796                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2797                 assert_eq!(added_monitors.len(), 2);
2798                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2799                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2800                 added_monitors.clear();
2801         }
2802         assert_eq!(events.len(), 3);
2803         match events[0] {
2804                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2805                 _ => panic!("Unexpected event"),
2806         }
2807         match events[1] {
2808                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2809                 _ => panic!("Unexpected event"),
2810         }
2811
2812         match events[2] {
2813                 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, .. } } => {
2814                         assert!(update_add_htlcs.is_empty());
2815                         assert!(update_fail_htlcs.is_empty());
2816                         assert_eq!(update_fulfill_htlcs.len(), 1);
2817                         assert!(update_fail_malformed_htlcs.is_empty());
2818                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2819                 },
2820                 _ => panic!("Unexpected event"),
2821         };
2822         macro_rules! check_tx_local_broadcast {
2823                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2824                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2825                         assert_eq!(node_txn.len(), 3);
2826                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2827                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2828                         check_spends!(node_txn[1], $commitment_tx);
2829                         check_spends!(node_txn[2], $commitment_tx);
2830                         assert_ne!(node_txn[1].lock_time, 0);
2831                         assert_ne!(node_txn[2].lock_time, 0);
2832                         if $htlc_offered {
2833                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2834                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2835                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2836                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2837                         } else {
2838                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2839                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2840                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2841                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2842                         }
2843                         check_spends!(node_txn[0], $chan_tx);
2844                         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2845                         node_txn.clear();
2846                 } }
2847         }
2848         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2849         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2850         // timeout-claim of the output that nodes[2] just claimed via success.
2851         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2852
2853         // Broadcast legit commitment tx from A on B's chain
2854         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2855         let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2856         check_spends!(node_a_commitment_tx[0], chan_1.3);
2857         mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2858         check_closed_broadcast!(nodes[1], true);
2859         check_added_monitors!(nodes[1], 1);
2860         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2861         assert_eq!(node_txn.len(), 6); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 3 (HTLC-Success, 2* RBF bumps of above HTLC txn)
2862         let commitment_spend =
2863                 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2864                         check_spends!(node_txn[1], commitment_tx[0]);
2865                         check_spends!(node_txn[2], commitment_tx[0]);
2866                         assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2867                         &node_txn[0]
2868                 } else {
2869                         check_spends!(node_txn[0], commitment_tx[0]);
2870                         check_spends!(node_txn[1], commitment_tx[0]);
2871                         assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2872                         &node_txn[2]
2873                 };
2874
2875         check_spends!(commitment_spend, node_a_commitment_tx[0]);
2876         assert_eq!(commitment_spend.input.len(), 2);
2877         assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2878         assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2879         assert_eq!(commitment_spend.lock_time, 0);
2880         assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2881         check_spends!(node_txn[3], chan_1.3);
2882         assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2883         check_spends!(node_txn[4], node_txn[3]);
2884         check_spends!(node_txn[5], node_txn[3]);
2885         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2886         // we already checked the same situation with A.
2887
2888         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2889         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2890         connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
2891         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2892         check_closed_broadcast!(nodes[0], true);
2893         check_added_monitors!(nodes[0], 1);
2894         let events = nodes[0].node.get_and_clear_pending_events();
2895         assert_eq!(events.len(), 2);
2896         let mut first_claimed = false;
2897         for event in events {
2898                 match event {
2899                         Event::PaymentSent { payment_preimage } => {
2900                                 if payment_preimage == our_payment_preimage {
2901                                         assert!(!first_claimed);
2902                                         first_claimed = true;
2903                                 } else {
2904                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2905                                 }
2906                         },
2907                         _ => panic!("Unexpected event"),
2908                 }
2909         }
2910         check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0], chan_1.3);
2911 }
2912
2913 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2914         // Test that in case of a unilateral close onchain, we detect the state of output and
2915         // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2916         // broadcasting the right event to other nodes in payment path.
2917         // A ------------------> B ----------------------> C (timeout)
2918         //    B's commitment tx                 C's commitment tx
2919         //            \                                  \
2920         //         B's HTLC timeout tx               B's timeout tx
2921
2922         let chanmon_cfgs = create_chanmon_cfgs(3);
2923         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2924         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2925         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2926         *nodes[0].connect_style.borrow_mut() = connect_style;
2927         *nodes[1].connect_style.borrow_mut() = connect_style;
2928         *nodes[2].connect_style.borrow_mut() = connect_style;
2929
2930         // Create some intial channels
2931         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2932         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2933
2934         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2935         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2936         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2937
2938         let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2939
2940         // Broadcast legit commitment tx from C on B's chain
2941         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2942         check_spends!(commitment_tx[0], chan_2.3);
2943         nodes[2].node.fail_htlc_backwards(&payment_hash);
2944         check_added_monitors!(nodes[2], 0);
2945         expect_pending_htlcs_forwardable!(nodes[2]);
2946         check_added_monitors!(nodes[2], 1);
2947
2948         let events = nodes[2].node.get_and_clear_pending_msg_events();
2949         assert_eq!(events.len(), 1);
2950         match events[0] {
2951                 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, .. } } => {
2952                         assert!(update_add_htlcs.is_empty());
2953                         assert!(!update_fail_htlcs.is_empty());
2954                         assert!(update_fulfill_htlcs.is_empty());
2955                         assert!(update_fail_malformed_htlcs.is_empty());
2956                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2957                 },
2958                 _ => panic!("Unexpected event"),
2959         };
2960         mine_transaction(&nodes[2], &commitment_tx[0]);
2961         check_closed_broadcast!(nodes[2], true);
2962         check_added_monitors!(nodes[2], 1);
2963         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2964         assert_eq!(node_txn.len(), 1);
2965         check_spends!(node_txn[0], chan_2.3);
2966         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2967
2968         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2969         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2970         connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2971         mine_transaction(&nodes[1], &commitment_tx[0]);
2972         let timeout_tx;
2973         {
2974                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2975                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2976                 assert_eq!(node_txn[0], node_txn[3]);
2977                 assert_eq!(node_txn[1], node_txn[4]);
2978
2979                 check_spends!(node_txn[2], commitment_tx[0]);
2980                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2981
2982                 check_spends!(node_txn[0], chan_2.3);
2983                 check_spends!(node_txn[1], node_txn[0]);
2984                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2985                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2986
2987                 timeout_tx = node_txn[2].clone();
2988                 node_txn.clear();
2989         }
2990
2991         mine_transaction(&nodes[1], &timeout_tx);
2992         check_added_monitors!(nodes[1], 1);
2993         check_closed_broadcast!(nodes[1], true);
2994         {
2995                 // B will rebroadcast a fee-bumped timeout transaction here.
2996                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2997                 assert_eq!(node_txn.len(), 1);
2998                 check_spends!(node_txn[0], commitment_tx[0]);
2999         }
3000
3001         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3002         {
3003                 // B may rebroadcast its own holder commitment transaction here, as a safeguard against
3004                 // some incredibly unlikely partial-eclipse-attack scenarios. That said, because the
3005                 // original commitment_tx[0] (also spending chan_2.3) has reached ANTI_REORG_DELAY B really
3006                 // shouldn't broadcast anything here, and in some connect style scenarios we do not.
3007                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3008                 if node_txn.len() == 1 {
3009                         check_spends!(node_txn[0], chan_2.3);
3010                 } else {
3011                         assert_eq!(node_txn.len(), 0);
3012                 }
3013         }
3014
3015         expect_pending_htlcs_forwardable!(nodes[1]);
3016         check_added_monitors!(nodes[1], 1);
3017         let events = nodes[1].node.get_and_clear_pending_msg_events();
3018         assert_eq!(events.len(), 1);
3019         match events[0] {
3020                 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, .. } } => {
3021                         assert!(update_add_htlcs.is_empty());
3022                         assert!(!update_fail_htlcs.is_empty());
3023                         assert!(update_fulfill_htlcs.is_empty());
3024                         assert!(update_fail_malformed_htlcs.is_empty());
3025                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3026                 },
3027                 _ => panic!("Unexpected event"),
3028         };
3029
3030         // Broadcast legit commitment tx from B on A's chain
3031         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3032         check_spends!(commitment_tx[0], chan_1.3);
3033
3034         mine_transaction(&nodes[0], &commitment_tx[0]);
3035         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
3036
3037         check_closed_broadcast!(nodes[0], true);
3038         check_added_monitors!(nodes[0], 1);
3039         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 commitment tx, ChannelMonitor : 1 timeout tx
3040         assert_eq!(node_txn.len(), 2);
3041         check_spends!(node_txn[0], chan_1.3);
3042         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
3043         check_spends!(node_txn[1], commitment_tx[0]);
3044         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3045 }
3046
3047 #[test]
3048 fn test_htlc_on_chain_timeout() {
3049         do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
3050         do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
3051         do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
3052 }
3053
3054 #[test]
3055 fn test_simple_commitment_revoked_fail_backward() {
3056         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3057         // and fail backward accordingly.
3058
3059         let chanmon_cfgs = create_chanmon_cfgs(3);
3060         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3061         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3062         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3063
3064         // Create some initial channels
3065         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3066         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3067
3068         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3069         // Get the will-be-revoked local txn from nodes[2]
3070         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3071         // Revoke the old state
3072         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3073
3074         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3075
3076         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3077         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3078         check_added_monitors!(nodes[1], 1);
3079         check_closed_broadcast!(nodes[1], true);
3080
3081         expect_pending_htlcs_forwardable!(nodes[1]);
3082         check_added_monitors!(nodes[1], 1);
3083         let events = nodes[1].node.get_and_clear_pending_msg_events();
3084         assert_eq!(events.len(), 1);
3085         match events[0] {
3086                 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, .. } } => {
3087                         assert!(update_add_htlcs.is_empty());
3088                         assert_eq!(update_fail_htlcs.len(), 1);
3089                         assert!(update_fulfill_htlcs.is_empty());
3090                         assert!(update_fail_malformed_htlcs.is_empty());
3091                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3092
3093                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3094                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3095                         expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, true);
3096                         expect_payment_failed!(nodes[0], payment_hash, false);
3097                 },
3098                 _ => panic!("Unexpected event"),
3099         }
3100 }
3101
3102 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3103         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3104         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3105         // commitment transaction anymore.
3106         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3107         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3108         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3109         // technically disallowed and we should probably handle it reasonably.
3110         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3111         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3112         // transactions:
3113         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3114         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3115         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3116         //   and once they revoke the previous commitment transaction (allowing us to send a new
3117         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3118         let chanmon_cfgs = create_chanmon_cfgs(3);
3119         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3120         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3121         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3122
3123         // Create some initial channels
3124         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3125         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3126
3127         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 });
3128         // Get the will-be-revoked local txn from nodes[2]
3129         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3130         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3131         // Revoke the old state
3132         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3133
3134         let value = if use_dust {
3135                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3136                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3137                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3138         } else { 3000000 };
3139
3140         let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3141         let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3142         let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3143
3144         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
3145         expect_pending_htlcs_forwardable!(nodes[2]);
3146         check_added_monitors!(nodes[2], 1);
3147         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3148         assert!(updates.update_add_htlcs.is_empty());
3149         assert!(updates.update_fulfill_htlcs.is_empty());
3150         assert!(updates.update_fail_malformed_htlcs.is_empty());
3151         assert_eq!(updates.update_fail_htlcs.len(), 1);
3152         assert!(updates.update_fee.is_none());
3153         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3154         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3155         // Drop the last RAA from 3 -> 2
3156
3157         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
3158         expect_pending_htlcs_forwardable!(nodes[2]);
3159         check_added_monitors!(nodes[2], 1);
3160         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3161         assert!(updates.update_add_htlcs.is_empty());
3162         assert!(updates.update_fulfill_htlcs.is_empty());
3163         assert!(updates.update_fail_malformed_htlcs.is_empty());
3164         assert_eq!(updates.update_fail_htlcs.len(), 1);
3165         assert!(updates.update_fee.is_none());
3166         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3167         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3168         check_added_monitors!(nodes[1], 1);
3169         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3170         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3171         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3172         check_added_monitors!(nodes[2], 1);
3173
3174         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
3175         expect_pending_htlcs_forwardable!(nodes[2]);
3176         check_added_monitors!(nodes[2], 1);
3177         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3178         assert!(updates.update_add_htlcs.is_empty());
3179         assert!(updates.update_fulfill_htlcs.is_empty());
3180         assert!(updates.update_fail_malformed_htlcs.is_empty());
3181         assert_eq!(updates.update_fail_htlcs.len(), 1);
3182         assert!(updates.update_fee.is_none());
3183         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3184         // At this point first_payment_hash has dropped out of the latest two commitment
3185         // transactions that nodes[1] is tracking...
3186         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3187         check_added_monitors!(nodes[1], 1);
3188         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3189         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3190         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3191         check_added_monitors!(nodes[2], 1);
3192
3193         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3194         // on nodes[2]'s RAA.
3195         let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3196         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3197         let logger = test_utils::TestLogger::new();
3198         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3199         nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
3200         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3201         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3202         check_added_monitors!(nodes[1], 0);
3203
3204         if deliver_bs_raa {
3205                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3206                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3207                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3208                 check_added_monitors!(nodes[1], 1);
3209                 let events = nodes[1].node.get_and_clear_pending_events();
3210                 assert_eq!(events.len(), 1);
3211                 match events[0] {
3212                         Event::PendingHTLCsForwardable { .. } => { },
3213                         _ => panic!("Unexpected event"),
3214                 };
3215                 // Deliberately don't process the pending fail-back so they all fail back at once after
3216                 // block connection just like the !deliver_bs_raa case
3217         }
3218
3219         let mut failed_htlcs = HashSet::new();
3220         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3221
3222         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3223         check_added_monitors!(nodes[1], 1);
3224         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3225
3226         let events = nodes[1].node.get_and_clear_pending_events();
3227         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3228         match events[0] {
3229                 Event::PaymentFailed { ref payment_hash, .. } => {
3230                         assert_eq!(*payment_hash, fourth_payment_hash);
3231                 },
3232                 _ => panic!("Unexpected event"),
3233         }
3234         if !deliver_bs_raa {
3235                 match events[1] {
3236                         Event::PendingHTLCsForwardable { .. } => { },
3237                         _ => panic!("Unexpected event"),
3238                 };
3239         }
3240         nodes[1].node.process_pending_htlc_forwards();
3241         check_added_monitors!(nodes[1], 1);
3242
3243         let events = nodes[1].node.get_and_clear_pending_msg_events();
3244         assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3245         match events[if deliver_bs_raa { 1 } else { 0 }] {
3246                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3247                 _ => panic!("Unexpected event"),
3248         }
3249         match events[if deliver_bs_raa { 2 } else { 1 }] {
3250                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3251                         assert_eq!(channel_id, chan_2.2);
3252                         assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3253                 },
3254                 _ => panic!("Unexpected event"),
3255         }
3256         if deliver_bs_raa {
3257                 match events[0] {
3258                         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, .. } } => {
3259                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3260                                 assert_eq!(update_add_htlcs.len(), 1);
3261                                 assert!(update_fulfill_htlcs.is_empty());
3262                                 assert!(update_fail_htlcs.is_empty());
3263                                 assert!(update_fail_malformed_htlcs.is_empty());
3264                         },
3265                         _ => panic!("Unexpected event"),
3266                 }
3267         }
3268         match events[if deliver_bs_raa { 3 } else { 2 }] {
3269                 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, .. } } => {
3270                         assert!(update_add_htlcs.is_empty());
3271                         assert_eq!(update_fail_htlcs.len(), 3);
3272                         assert!(update_fulfill_htlcs.is_empty());
3273                         assert!(update_fail_malformed_htlcs.is_empty());
3274                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3275
3276                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3277                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3278                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3279
3280                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3281
3282                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3283                         // If we delivered B's RAA we got an unknown preimage error, not something
3284                         // that we should update our routing table for.
3285                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3286                         for event in events {
3287                                 match event {
3288                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3289                                         _ => panic!("Unexpected event"),
3290                                 }
3291                         }
3292                         let events = nodes[0].node.get_and_clear_pending_events();
3293                         assert_eq!(events.len(), 3);
3294                         match events[0] {
3295                                 Event::PaymentFailed { ref payment_hash, .. } => {
3296                                         assert!(failed_htlcs.insert(payment_hash.0));
3297                                 },
3298                                 _ => panic!("Unexpected event"),
3299                         }
3300                         match events[1] {
3301                                 Event::PaymentFailed { ref payment_hash, .. } => {
3302                                         assert!(failed_htlcs.insert(payment_hash.0));
3303                                 },
3304                                 _ => panic!("Unexpected event"),
3305                         }
3306                         match events[2] {
3307                                 Event::PaymentFailed { ref payment_hash, .. } => {
3308                                         assert!(failed_htlcs.insert(payment_hash.0));
3309                                 },
3310                                 _ => panic!("Unexpected event"),
3311                         }
3312                 },
3313                 _ => panic!("Unexpected event"),
3314         }
3315
3316         assert!(failed_htlcs.contains(&first_payment_hash.0));
3317         assert!(failed_htlcs.contains(&second_payment_hash.0));
3318         assert!(failed_htlcs.contains(&third_payment_hash.0));
3319 }
3320
3321 #[test]
3322 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3323         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3324         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3325         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3326         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3327 }
3328
3329 #[test]
3330 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3331         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3332         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3333         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3334         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3335 }
3336
3337 #[test]
3338 fn fail_backward_pending_htlc_upon_channel_failure() {
3339         let chanmon_cfgs = create_chanmon_cfgs(2);
3340         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3341         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3342         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3343         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3344         let logger = test_utils::TestLogger::new();
3345
3346         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3347         {
3348                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3349                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3350                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3351                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3352                 check_added_monitors!(nodes[0], 1);
3353
3354                 let payment_event = {
3355                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3356                         assert_eq!(events.len(), 1);
3357                         SendEvent::from_event(events.remove(0))
3358                 };
3359                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3360                 assert_eq!(payment_event.msgs.len(), 1);
3361         }
3362
3363         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3364         let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3365         {
3366                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3367                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3368                 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3369                 check_added_monitors!(nodes[0], 0);
3370
3371                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3372         }
3373
3374         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3375         {
3376                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3377
3378                 let secp_ctx = Secp256k1::new();
3379                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3380                 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3381                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3382                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3383                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height).unwrap();
3384                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3385                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3386
3387                 // Send a 0-msat update_add_htlc to fail the channel.
3388                 let update_add_htlc = msgs::UpdateAddHTLC {
3389                         channel_id: chan.2,
3390                         htlc_id: 0,
3391                         amount_msat: 0,
3392                         payment_hash,
3393                         cltv_expiry,
3394                         onion_routing_packet,
3395                 };
3396                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3397         }
3398
3399         // Check that Alice fails backward the pending HTLC from the second payment.
3400         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3401         check_closed_broadcast!(nodes[0], true);
3402         check_added_monitors!(nodes[0], 1);
3403 }
3404
3405 #[test]
3406 fn test_htlc_ignore_latest_remote_commitment() {
3407         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3408         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3409         let chanmon_cfgs = create_chanmon_cfgs(2);
3410         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3411         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3412         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3413         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3414
3415         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3416         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3417         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3418         check_closed_broadcast!(nodes[0], true);
3419         check_added_monitors!(nodes[0], 1);
3420
3421         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3422         assert_eq!(node_txn.len(), 3);
3423         assert_eq!(node_txn[0], node_txn[1]);
3424
3425         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3426         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3427         check_closed_broadcast!(nodes[1], true);
3428         check_added_monitors!(nodes[1], 1);
3429
3430         // Duplicate the connect_block call since this may happen due to other listeners
3431         // registering new transactions
3432         header.prev_blockhash = header.block_hash();
3433         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3434 }
3435
3436 #[test]
3437 fn test_force_close_fail_back() {
3438         // Check which HTLCs are failed-backwards on channel force-closure
3439         let chanmon_cfgs = create_chanmon_cfgs(3);
3440         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3441         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3442         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3443         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3444         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3445         let logger = test_utils::TestLogger::new();
3446
3447         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3448
3449         let mut payment_event = {
3450                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3451                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, 42, &logger).unwrap();
3452                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3453                 check_added_monitors!(nodes[0], 1);
3454
3455                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3456                 assert_eq!(events.len(), 1);
3457                 SendEvent::from_event(events.remove(0))
3458         };
3459
3460         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3461         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3462
3463         expect_pending_htlcs_forwardable!(nodes[1]);
3464
3465         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3466         assert_eq!(events_2.len(), 1);
3467         payment_event = SendEvent::from_event(events_2.remove(0));
3468         assert_eq!(payment_event.msgs.len(), 1);
3469
3470         check_added_monitors!(nodes[1], 1);
3471         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3472         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3473         check_added_monitors!(nodes[2], 1);
3474         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3475
3476         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3477         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3478         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3479
3480         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3481         check_closed_broadcast!(nodes[2], true);
3482         check_added_monitors!(nodes[2], 1);
3483         let tx = {
3484                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3485                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3486                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3487                 // back to nodes[1] upon timeout otherwise.
3488                 assert_eq!(node_txn.len(), 1);
3489                 node_txn.remove(0)
3490         };
3491
3492         mine_transaction(&nodes[1], &tx);
3493
3494         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3495         check_closed_broadcast!(nodes[1], true);
3496         check_added_monitors!(nodes[1], 1);
3497
3498         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3499         {
3500                 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3501                 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3502                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3503         }
3504         mine_transaction(&nodes[2], &tx);
3505         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3506         assert_eq!(node_txn.len(), 1);
3507         assert_eq!(node_txn[0].input.len(), 1);
3508         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3509         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3510         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3511
3512         check_spends!(node_txn[0], tx);
3513 }
3514
3515 #[test]
3516 fn test_dup_events_on_peer_disconnect() {
3517         // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3518         // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3519         // as we used to generate the event immediately upon receipt of the payment preimage in the
3520         // update_fulfill_htlc message.
3521
3522         let chanmon_cfgs = create_chanmon_cfgs(2);
3523         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3524         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3525         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3526         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3527
3528         let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3529
3530         assert!(nodes[1].node.claim_funds(payment_preimage));
3531         check_added_monitors!(nodes[1], 1);
3532         let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3533         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3534         expect_payment_sent!(nodes[0], payment_preimage);
3535
3536         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3537         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3538
3539         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3540         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3541 }
3542
3543 #[test]
3544 fn test_simple_peer_disconnect() {
3545         // Test that we can reconnect when there are no lost messages
3546         let chanmon_cfgs = create_chanmon_cfgs(3);
3547         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3548         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3549         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3550         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3551         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3552
3553         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3554         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3555         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3556
3557         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3558         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3559         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3560         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3561
3562         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3563         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3564         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3565
3566         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3567         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3568         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3569         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3570
3571         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3572         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3573
3574         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3575         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3576
3577         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3578         {
3579                 let events = nodes[0].node.get_and_clear_pending_events();
3580                 assert_eq!(events.len(), 2);
3581                 match events[0] {
3582                         Event::PaymentSent { payment_preimage } => {
3583                                 assert_eq!(payment_preimage, payment_preimage_3);
3584                         },
3585                         _ => panic!("Unexpected event"),
3586                 }
3587                 match events[1] {
3588                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3589                                 assert_eq!(payment_hash, payment_hash_5);
3590                                 assert!(rejected_by_dest);
3591                         },
3592                         _ => panic!("Unexpected event"),
3593                 }
3594         }
3595
3596         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3597         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3598 }
3599
3600 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken_lnd: bool) {
3601         // Test that we can reconnect when in-flight HTLC updates get dropped
3602         let chanmon_cfgs = create_chanmon_cfgs(2);
3603         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3604         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3605         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3606
3607         let mut as_funding_locked = None;
3608         if messages_delivered == 0 {
3609                 let (funding_locked, _, _) = create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3610                 as_funding_locked = Some(funding_locked);
3611                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3612                 // Note that we store it so that if we're running with `simulate_broken_lnd` we can deliver
3613                 // it before the channel_reestablish message.
3614         } else {
3615                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3616         }
3617
3618         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3619
3620         let logger = test_utils::TestLogger::new();
3621         let payment_event = {
3622                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3623                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3624                         &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3625                         &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3626                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3627                 check_added_monitors!(nodes[0], 1);
3628
3629                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3630                 assert_eq!(events.len(), 1);
3631                 SendEvent::from_event(events.remove(0))
3632         };
3633         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3634
3635         if messages_delivered < 2 {
3636                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3637         } else {
3638                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3639                 if messages_delivered >= 3 {
3640                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3641                         check_added_monitors!(nodes[1], 1);
3642                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3643
3644                         if messages_delivered >= 4 {
3645                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3646                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3647                                 check_added_monitors!(nodes[0], 1);
3648
3649                                 if messages_delivered >= 5 {
3650                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3651                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3652                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3653                                         check_added_monitors!(nodes[0], 1);
3654
3655                                         if messages_delivered >= 6 {
3656                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3657                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3658                                                 check_added_monitors!(nodes[1], 1);
3659                                         }
3660                                 }
3661                         }
3662                 }
3663         }
3664
3665         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3666         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3667         if messages_delivered < 3 {
3668                 if simulate_broken_lnd {
3669                         // lnd has a long-standing bug where they send a funding_locked prior to a
3670                         // channel_reestablish if you reconnect prior to funding_locked time.
3671                         //
3672                         // Here we simulate that behavior, delivering a funding_locked immediately on
3673                         // reconnect. Note that we don't bother skipping the now-duplicate funding_locked sent
3674                         // in `reconnect_nodes` but we currently don't fail based on that.
3675                         //
3676                         // See-also <https://github.com/lightningnetwork/lnd/issues/4006>
3677                         nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding_locked.as_ref().unwrap().0);
3678                 }
3679                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3680                 // received on either side, both sides will need to resend them.
3681                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3682         } else if messages_delivered == 3 {
3683                 // nodes[0] still wants its RAA + commitment_signed
3684                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3685         } else if messages_delivered == 4 {
3686                 // nodes[0] still wants its commitment_signed
3687                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3688         } else if messages_delivered == 5 {
3689                 // nodes[1] still wants its final RAA
3690                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3691         } else if messages_delivered == 6 {
3692                 // Everything was delivered...
3693                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3694         }
3695
3696         let events_1 = nodes[1].node.get_and_clear_pending_events();
3697         assert_eq!(events_1.len(), 1);
3698         match events_1[0] {
3699                 Event::PendingHTLCsForwardable { .. } => { },
3700                 _ => panic!("Unexpected event"),
3701         };
3702
3703         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3704         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3705         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3706
3707         nodes[1].node.process_pending_htlc_forwards();
3708
3709         let events_2 = nodes[1].node.get_and_clear_pending_events();
3710         assert_eq!(events_2.len(), 1);
3711         match events_2[0] {
3712                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
3713                         assert_eq!(payment_hash_1, *payment_hash);
3714                         assert!(payment_preimage.is_none());
3715                         assert_eq!(payment_secret_1, *payment_secret);
3716                         assert_eq!(amt, 1000000);
3717                 },
3718                 _ => panic!("Unexpected event"),
3719         }
3720
3721         nodes[1].node.claim_funds(payment_preimage_1);
3722         check_added_monitors!(nodes[1], 1);
3723
3724         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3725         assert_eq!(events_3.len(), 1);
3726         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3727                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3728                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3729                         assert!(updates.update_add_htlcs.is_empty());
3730                         assert!(updates.update_fail_htlcs.is_empty());
3731                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3732                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3733                         assert!(updates.update_fee.is_none());
3734                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3735                 },
3736                 _ => panic!("Unexpected event"),
3737         };
3738
3739         if messages_delivered >= 1 {
3740                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3741
3742                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3743                 assert_eq!(events_4.len(), 1);
3744                 match events_4[0] {
3745                         Event::PaymentSent { ref payment_preimage } => {
3746                                 assert_eq!(payment_preimage_1, *payment_preimage);
3747                         },
3748                         _ => panic!("Unexpected event"),
3749                 }
3750
3751                 if messages_delivered >= 2 {
3752                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3753                         check_added_monitors!(nodes[0], 1);
3754                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3755
3756                         if messages_delivered >= 3 {
3757                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3758                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3759                                 check_added_monitors!(nodes[1], 1);
3760
3761                                 if messages_delivered >= 4 {
3762                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3763                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3764                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3765                                         check_added_monitors!(nodes[1], 1);
3766
3767                                         if messages_delivered >= 5 {
3768                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3769                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3770                                                 check_added_monitors!(nodes[0], 1);
3771                                         }
3772                                 }
3773                         }
3774                 }
3775         }
3776
3777         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3778         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3779         if messages_delivered < 2 {
3780                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3781                 if messages_delivered < 1 {
3782                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3783                         assert_eq!(events_4.len(), 1);
3784                         match events_4[0] {
3785                                 Event::PaymentSent { ref payment_preimage } => {
3786                                         assert_eq!(payment_preimage_1, *payment_preimage);
3787                                 },
3788                                 _ => panic!("Unexpected event"),
3789                         }
3790                 } else {
3791                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3792                 }
3793         } else if messages_delivered == 2 {
3794                 // nodes[0] still wants its RAA + commitment_signed
3795                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3796         } else if messages_delivered == 3 {
3797                 // nodes[0] still wants its commitment_signed
3798                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3799         } else if messages_delivered == 4 {
3800                 // nodes[1] still wants its final RAA
3801                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3802         } else if messages_delivered == 5 {
3803                 // Everything was delivered...
3804                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3805         }
3806
3807         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3808         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3809         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3810
3811         // Channel should still work fine...
3812         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3813         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3814                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3815                 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3816         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3817         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3818 }
3819
3820 #[test]
3821 fn test_drop_messages_peer_disconnect_a() {
3822         do_test_drop_messages_peer_disconnect(0, true);
3823         do_test_drop_messages_peer_disconnect(0, false);
3824         do_test_drop_messages_peer_disconnect(1, false);
3825         do_test_drop_messages_peer_disconnect(2, false);
3826 }
3827
3828 #[test]
3829 fn test_drop_messages_peer_disconnect_b() {
3830         do_test_drop_messages_peer_disconnect(3, false);
3831         do_test_drop_messages_peer_disconnect(4, false);
3832         do_test_drop_messages_peer_disconnect(5, false);
3833         do_test_drop_messages_peer_disconnect(6, false);
3834 }
3835
3836 #[test]
3837 fn test_funding_peer_disconnect() {
3838         // Test that we can lock in our funding tx while disconnected
3839         let chanmon_cfgs = create_chanmon_cfgs(2);
3840         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3841         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3842         let persister: test_utils::TestPersister;
3843         let new_chain_monitor: test_utils::TestChainMonitor;
3844         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3845         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3846         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3847
3848         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3849         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3850
3851         confirm_transaction(&nodes[0], &tx);
3852         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3853         assert_eq!(events_1.len(), 1);
3854         match events_1[0] {
3855                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3856                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3857                 },
3858                 _ => panic!("Unexpected event"),
3859         }
3860
3861         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3862
3863         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3864         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3865
3866         confirm_transaction(&nodes[1], &tx);
3867         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3868         assert_eq!(events_2.len(), 2);
3869         let funding_locked = match events_2[0] {
3870                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3871                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3872                         msg.clone()
3873                 },
3874                 _ => panic!("Unexpected event"),
3875         };
3876         let bs_announcement_sigs = match events_2[1] {
3877                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3878                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3879                         msg.clone()
3880                 },
3881                 _ => panic!("Unexpected event"),
3882         };
3883
3884         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3885
3886         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3887         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3888         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3889         assert_eq!(events_3.len(), 2);
3890         let as_announcement_sigs = match events_3[0] {
3891                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3892                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3893                         msg.clone()
3894                 },
3895                 _ => panic!("Unexpected event"),
3896         };
3897         let (as_announcement, as_update) = match events_3[1] {
3898                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3899                         (msg.clone(), update_msg.clone())
3900                 },
3901                 _ => panic!("Unexpected event"),
3902         };
3903
3904         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3905         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3906         assert_eq!(events_4.len(), 1);
3907         let (_, bs_update) = match events_4[0] {
3908                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3909                         (msg.clone(), update_msg.clone())
3910                 },
3911                 _ => panic!("Unexpected event"),
3912         };
3913
3914         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3915         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3916         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3917
3918         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3919         let logger = test_utils::TestLogger::new();
3920         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3921         let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3922         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3923
3924         // Check that after deserialization and reconnection we can still generate an identical
3925         // channel_announcement from the cached signatures.
3926         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3927
3928         let nodes_0_serialized = nodes[0].node.encode();
3929         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3930         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3931
3932         persister = test_utils::TestPersister::new();
3933         let keys_manager = &chanmon_cfgs[0].keys_manager;
3934         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);
3935         nodes[0].chain_monitor = &new_chain_monitor;
3936         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3937         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3938                 &mut chan_0_monitor_read, keys_manager).unwrap();
3939         assert!(chan_0_monitor_read.is_empty());
3940
3941         let mut nodes_0_read = &nodes_0_serialized[..];
3942         let (_, nodes_0_deserialized_tmp) = {
3943                 let mut channel_monitors = HashMap::new();
3944                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3945                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3946                         default_config: UserConfig::default(),
3947                         keys_manager,
3948                         fee_estimator: node_cfgs[0].fee_estimator,
3949                         chain_monitor: nodes[0].chain_monitor,
3950                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3951                         logger: nodes[0].logger,
3952                         channel_monitors,
3953                 }).unwrap()
3954         };
3955         nodes_0_deserialized = nodes_0_deserialized_tmp;
3956         assert!(nodes_0_read.is_empty());
3957
3958         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
3959         nodes[0].node = &nodes_0_deserialized;
3960         check_added_monitors!(nodes[0], 1);
3961
3962         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3963
3964         // as_announcement should be re-generated exactly by broadcast_node_announcement.
3965         nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
3966         let msgs = nodes[0].node.get_and_clear_pending_msg_events();
3967         let mut found_announcement = false;
3968         for event in msgs.iter() {
3969                 match event {
3970                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
3971                                 if *msg == as_announcement { found_announcement = true; }
3972                         },
3973                         MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
3974                         _ => panic!("Unexpected event"),
3975                 }
3976         }
3977         assert!(found_announcement);
3978 }
3979
3980 #[test]
3981 fn test_drop_messages_peer_disconnect_dual_htlc() {
3982         // Test that we can handle reconnecting when both sides of a channel have pending
3983         // commitment_updates when we disconnect.
3984         let chanmon_cfgs = create_chanmon_cfgs(2);
3985         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3986         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3987         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3988         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3989         let logger = test_utils::TestLogger::new();
3990
3991         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3992
3993         // Now try to send a second payment which will fail to send
3994         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
3995         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3996         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3997         nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
3998         check_added_monitors!(nodes[0], 1);
3999
4000         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
4001         assert_eq!(events_1.len(), 1);
4002         match events_1[0] {
4003                 MessageSendEvent::UpdateHTLCs { .. } => {},
4004                 _ => panic!("Unexpected event"),
4005         }
4006
4007         assert!(nodes[1].node.claim_funds(payment_preimage_1));
4008         check_added_monitors!(nodes[1], 1);
4009
4010         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
4011         assert_eq!(events_2.len(), 1);
4012         match events_2[0] {
4013                 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 } } => {
4014                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4015                         assert!(update_add_htlcs.is_empty());
4016                         assert_eq!(update_fulfill_htlcs.len(), 1);
4017                         assert!(update_fail_htlcs.is_empty());
4018                         assert!(update_fail_malformed_htlcs.is_empty());
4019                         assert!(update_fee.is_none());
4020
4021                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
4022                         let events_3 = nodes[0].node.get_and_clear_pending_events();
4023                         assert_eq!(events_3.len(), 1);
4024                         match events_3[0] {
4025                                 Event::PaymentSent { ref payment_preimage } => {
4026                                         assert_eq!(*payment_preimage, payment_preimage_1);
4027                                 },
4028                                 _ => panic!("Unexpected event"),
4029                         }
4030
4031                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
4032                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4033                         // No commitment_signed so get_event_msg's assert(len == 1) passes
4034                         check_added_monitors!(nodes[0], 1);
4035                 },
4036                 _ => panic!("Unexpected event"),
4037         }
4038
4039         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4040         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4041
4042         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4043         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4044         assert_eq!(reestablish_1.len(), 1);
4045         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4046         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4047         assert_eq!(reestablish_2.len(), 1);
4048
4049         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4050         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4051         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4052         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4053
4054         assert!(as_resp.0.is_none());
4055         assert!(bs_resp.0.is_none());
4056
4057         assert!(bs_resp.1.is_none());
4058         assert!(bs_resp.2.is_none());
4059
4060         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4061
4062         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
4063         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
4064         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4065         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4066         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
4067         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
4068         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
4069         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4070         // No commitment_signed so get_event_msg's assert(len == 1) passes
4071         check_added_monitors!(nodes[1], 1);
4072
4073         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
4074         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4075         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4076         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4077         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4078         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4079         assert!(bs_second_commitment_signed.update_fee.is_none());
4080         check_added_monitors!(nodes[1], 1);
4081
4082         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4083         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4084         assert!(as_commitment_signed.update_add_htlcs.is_empty());
4085         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4086         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4087         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4088         assert!(as_commitment_signed.update_fee.is_none());
4089         check_added_monitors!(nodes[0], 1);
4090
4091         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4092         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4093         // No commitment_signed so get_event_msg's assert(len == 1) passes
4094         check_added_monitors!(nodes[0], 1);
4095
4096         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4097         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4098         // No commitment_signed so get_event_msg's assert(len == 1) passes
4099         check_added_monitors!(nodes[1], 1);
4100
4101         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4102         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4103         check_added_monitors!(nodes[1], 1);
4104
4105         expect_pending_htlcs_forwardable!(nodes[1]);
4106
4107         let events_5 = nodes[1].node.get_and_clear_pending_events();
4108         assert_eq!(events_5.len(), 1);
4109         match events_5[0] {
4110                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt: _, user_payment_id: _ } => {
4111                         assert_eq!(payment_hash_2, *payment_hash);
4112                         assert!(payment_preimage.is_none());
4113                         assert_eq!(payment_secret_2, *payment_secret);
4114                 },
4115                 _ => panic!("Unexpected event"),
4116         }
4117
4118         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4119         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4120         check_added_monitors!(nodes[0], 1);
4121
4122         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4123 }
4124
4125 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4126         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4127         // to avoid our counterparty failing the channel.
4128         let chanmon_cfgs = create_chanmon_cfgs(2);
4129         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4130         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4131         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4132
4133         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4134         let logger = test_utils::TestLogger::new();
4135
4136         let our_payment_hash = if send_partial_mpp {
4137                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4138                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4139                 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
4140                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4141                 // indicates there are more HTLCs coming.
4142                 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.
4143                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height).unwrap();
4144                 check_added_monitors!(nodes[0], 1);
4145                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4146                 assert_eq!(events.len(), 1);
4147                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4148                 // hop should *not* yet generate any PaymentReceived event(s).
4149                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, payment_secret, events.drain(..).next().unwrap(), false);
4150                 our_payment_hash
4151         } else {
4152                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4153         };
4154
4155         let mut block = Block {
4156                 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4157                 txdata: vec![],
4158         };
4159         connect_block(&nodes[0], &block);
4160         connect_block(&nodes[1], &block);
4161         let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
4162         for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
4163                 block.header.prev_blockhash = block.block_hash();
4164                 connect_block(&nodes[0], &block);
4165                 connect_block(&nodes[1], &block);
4166         }
4167
4168         expect_pending_htlcs_forwardable!(nodes[1]);
4169
4170         check_added_monitors!(nodes[1], 1);
4171         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4172         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4173         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4174         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4175         assert!(htlc_timeout_updates.update_fee.is_none());
4176
4177         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4178         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4179         // 100_000 msat as u64, followed by the height at which we failed back above
4180         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4181         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4182         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4183 }
4184
4185 #[test]
4186 fn test_htlc_timeout() {
4187         do_test_htlc_timeout(true);
4188         do_test_htlc_timeout(false);
4189 }
4190
4191 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4192         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4193         let chanmon_cfgs = create_chanmon_cfgs(3);
4194         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4195         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4196         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4197         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4198         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4199
4200         // Make sure all nodes are at the same starting height
4201         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4202         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4203         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4204
4205         let logger = test_utils::TestLogger::new();
4206
4207         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4208         let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4209         {
4210                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4211                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4212                 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4213         }
4214         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4215         check_added_monitors!(nodes[1], 1);
4216
4217         // Now attempt to route a second payment, which should be placed in the holding cell
4218         let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4219         if forwarded_htlc {
4220                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4221                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4222                 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4223                 check_added_monitors!(nodes[0], 1);
4224                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4225                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4226                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4227                 expect_pending_htlcs_forwardable!(nodes[1]);
4228                 check_added_monitors!(nodes[1], 0);
4229         } else {
4230                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4231                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4232                 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4233                 check_added_monitors!(nodes[1], 0);
4234         }
4235
4236         connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4237         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4238         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4239         connect_blocks(&nodes[1], 1);
4240
4241         if forwarded_htlc {
4242                 expect_pending_htlcs_forwardable!(nodes[1]);
4243                 check_added_monitors!(nodes[1], 1);
4244                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4245                 assert_eq!(fail_commit.len(), 1);
4246                 match fail_commit[0] {
4247                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4248                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4249                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4250                         },
4251                         _ => unreachable!(),
4252                 }
4253                 expect_payment_failed!(nodes[0], second_payment_hash, false);
4254                 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, false);
4255         } else {
4256                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4257         }
4258 }
4259
4260 #[test]
4261 fn test_holding_cell_htlc_add_timeouts() {
4262         do_test_holding_cell_htlc_add_timeouts(false);
4263         do_test_holding_cell_htlc_add_timeouts(true);
4264 }
4265
4266 #[test]
4267 fn test_invalid_channel_announcement() {
4268         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4269         let secp_ctx = Secp256k1::new();
4270         let chanmon_cfgs = create_chanmon_cfgs(2);
4271         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4272         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4273         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4274
4275         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4276
4277         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4278         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4279         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4280         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4281
4282         nodes[0].net_graph_msg_handler.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
4283
4284         let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4285         let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4286
4287         let as_network_key = nodes[0].node.get_our_node_id();
4288         let bs_network_key = nodes[1].node.get_our_node_id();
4289
4290         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4291
4292         let mut chan_announcement;
4293
4294         macro_rules! dummy_unsigned_msg {
4295                 () => {
4296                         msgs::UnsignedChannelAnnouncement {
4297                                 features: ChannelFeatures::known(),
4298                                 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4299                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4300                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4301                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4302                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4303                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4304                                 excess_data: Vec::new(),
4305                         };
4306                 }
4307         }
4308
4309         macro_rules! sign_msg {
4310                 ($unsigned_msg: expr) => {
4311                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4312                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4313                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4314                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4315                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4316                         chan_announcement = msgs::ChannelAnnouncement {
4317                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4318                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4319                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4320                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4321                                 contents: $unsigned_msg
4322                         }
4323                 }
4324         }
4325
4326         let unsigned_msg = dummy_unsigned_msg!();
4327         sign_msg!(unsigned_msg);
4328         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4329         let _ = nodes[0].net_graph_msg_handler.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
4330
4331         // Configured with Network::Testnet
4332         let mut unsigned_msg = dummy_unsigned_msg!();
4333         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4334         sign_msg!(unsigned_msg);
4335         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4336
4337         let mut unsigned_msg = dummy_unsigned_msg!();
4338         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4339         sign_msg!(unsigned_msg);
4340         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4341 }
4342
4343 #[test]
4344 fn test_no_txn_manager_serialize_deserialize() {
4345         let chanmon_cfgs = create_chanmon_cfgs(2);
4346         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4347         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4348         let logger: test_utils::TestLogger;
4349         let fee_estimator: test_utils::TestFeeEstimator;
4350         let persister: test_utils::TestPersister;
4351         let new_chain_monitor: test_utils::TestChainMonitor;
4352         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4353         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4354
4355         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
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: 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 config = UserConfig::default();
4376         let (_, nodes_0_deserialized_tmp) = {
4377                 let mut channel_monitors = HashMap::new();
4378                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4379                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4380                         default_config: config,
4381                         keys_manager,
4382                         fee_estimator: &fee_estimator,
4383                         chain_monitor: nodes[0].chain_monitor,
4384                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4385                         logger: &logger,
4386                         channel_monitors,
4387                 }).unwrap()
4388         };
4389         nodes_0_deserialized = nodes_0_deserialized_tmp;
4390         assert!(nodes_0_read.is_empty());
4391
4392         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4393         nodes[0].node = &nodes_0_deserialized;
4394         assert_eq!(nodes[0].node.list_channels().len(), 1);
4395         check_added_monitors!(nodes[0], 1);
4396
4397         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4398         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4399         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4400         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4401
4402         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4403         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4404         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4405         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4406
4407         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4408         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4409         for node in nodes.iter() {
4410                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4411                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4412                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4413         }
4414
4415         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4416 }
4417
4418 #[test]
4419 fn test_dup_htlc_onchain_fails_on_reload() {
4420         // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4421         // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4422         // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4423         // the ChannelMonitor tells it to.
4424         //
4425         // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4426         // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4427         // PaymentFailed event appearing). However, because we may not serialize the relevant
4428         // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4429         // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4430         // and de-duplicates ChannelMonitor events.
4431         //
4432         // This tests that explicit tracking behavior.
4433         let chanmon_cfgs = create_chanmon_cfgs(2);
4434         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4435         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4436         let persister: test_utils::TestPersister;
4437         let new_chain_monitor: test_utils::TestChainMonitor;
4438         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4439         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4440
4441         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4442
4443         // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4444         // nodes[0].
4445         let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4446         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4447         check_closed_broadcast!(nodes[0], true);
4448         check_added_monitors!(nodes[0], 1);
4449
4450         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4451         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4452
4453         // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
4454         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
4455         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4456         assert_eq!(node_txn.len(), 3);
4457         assert_eq!(node_txn[0], node_txn[1]);
4458
4459         assert!(nodes[1].node.claim_funds(payment_preimage));
4460         check_added_monitors!(nodes[1], 1);
4461
4462         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4463         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4464         check_closed_broadcast!(nodes[1], true);
4465         check_added_monitors!(nodes[1], 1);
4466         let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4467
4468         header.prev_blockhash = nodes[0].best_block_hash();
4469         connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4470
4471         // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4472         // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4473         // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4474         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4475         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4476
4477         header.prev_blockhash = nodes[0].best_block_hash();
4478         let claim_block = Block { header, txdata: claim_txn};
4479         connect_block(&nodes[0], &claim_block);
4480         expect_payment_sent!(nodes[0], payment_preimage);
4481
4482         // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4483         // connected a highly-relevant block, it likely gets serialized out now.
4484         let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4485         nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4486
4487         // Now reload nodes[0]...
4488         persister = test_utils::TestPersister::new();
4489         let keys_manager = &chanmon_cfgs[0].keys_manager;
4490         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);
4491         nodes[0].chain_monitor = &new_chain_monitor;
4492         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4493         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4494                 &mut chan_0_monitor_read, keys_manager).unwrap();
4495         assert!(chan_0_monitor_read.is_empty());
4496
4497         let (_, nodes_0_deserialized_tmp) = {
4498                 let mut channel_monitors = HashMap::new();
4499                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4500                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4501                         ::read(&mut std::io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4502                                 default_config: Default::default(),
4503                                 keys_manager,
4504                                 fee_estimator: node_cfgs[0].fee_estimator,
4505                                 chain_monitor: nodes[0].chain_monitor,
4506                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4507                                 logger: nodes[0].logger,
4508                                 channel_monitors,
4509                         }).unwrap()
4510         };
4511         nodes_0_deserialized = nodes_0_deserialized_tmp;
4512
4513         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4514         check_added_monitors!(nodes[0], 1);
4515         nodes[0].node = &nodes_0_deserialized;
4516
4517         // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4518         // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4519         // payment events should kick in, leaving us with no pending events here.
4520         let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
4521         nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
4522         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4523 }
4524
4525 #[test]
4526 fn test_manager_serialize_deserialize_events() {
4527         // This test makes sure the events field in ChannelManager survives de/serialization
4528         let chanmon_cfgs = create_chanmon_cfgs(2);
4529         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4530         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4531         let fee_estimator: test_utils::TestFeeEstimator;
4532         let persister: test_utils::TestPersister;
4533         let logger: test_utils::TestLogger;
4534         let new_chain_monitor: test_utils::TestChainMonitor;
4535         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4536         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4537
4538         // Start creating a channel, but stop right before broadcasting the funding transaction
4539         let channel_value = 100000;
4540         let push_msat = 10001;
4541         let a_flags = InitFeatures::known();
4542         let b_flags = InitFeatures::known();
4543         let node_a = nodes.remove(0);
4544         let node_b = nodes.remove(0);
4545         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4546         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()));
4547         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()));
4548
4549         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4550
4551         node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4552         check_added_monitors!(node_a, 0);
4553
4554         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()));
4555         {
4556                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4557                 assert_eq!(added_monitors.len(), 1);
4558                 assert_eq!(added_monitors[0].0, funding_output);
4559                 added_monitors.clear();
4560         }
4561
4562         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()));
4563         {
4564                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4565                 assert_eq!(added_monitors.len(), 1);
4566                 assert_eq!(added_monitors[0].0, funding_output);
4567                 added_monitors.clear();
4568         }
4569         // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4570
4571         nodes.push(node_a);
4572         nodes.push(node_b);
4573
4574         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4575         let nodes_0_serialized = nodes[0].node.encode();
4576         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4577         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4578
4579         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4580         logger = test_utils::TestLogger::new();
4581         persister = test_utils::TestPersister::new();
4582         let keys_manager = &chanmon_cfgs[0].keys_manager;
4583         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4584         nodes[0].chain_monitor = &new_chain_monitor;
4585         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4586         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4587                 &mut chan_0_monitor_read, keys_manager).unwrap();
4588         assert!(chan_0_monitor_read.is_empty());
4589
4590         let mut nodes_0_read = &nodes_0_serialized[..];
4591         let config = UserConfig::default();
4592         let (_, nodes_0_deserialized_tmp) = {
4593                 let mut channel_monitors = HashMap::new();
4594                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4595                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4596                         default_config: config,
4597                         keys_manager,
4598                         fee_estimator: &fee_estimator,
4599                         chain_monitor: nodes[0].chain_monitor,
4600                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4601                         logger: &logger,
4602                         channel_monitors,
4603                 }).unwrap()
4604         };
4605         nodes_0_deserialized = nodes_0_deserialized_tmp;
4606         assert!(nodes_0_read.is_empty());
4607
4608         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4609
4610         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4611         nodes[0].node = &nodes_0_deserialized;
4612
4613         // After deserializing, make sure the funding_transaction is still held by the channel manager
4614         let events_4 = nodes[0].node.get_and_clear_pending_events();
4615         assert_eq!(events_4.len(), 0);
4616         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4617         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4618
4619         // Make sure the channel is functioning as though the de/serialization never happened
4620         assert_eq!(nodes[0].node.list_channels().len(), 1);
4621         check_added_monitors!(nodes[0], 1);
4622
4623         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4624         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4625         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4626         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4627
4628         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4629         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4630         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4631         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4632
4633         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4634         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4635         for node in nodes.iter() {
4636                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4637                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4638                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4639         }
4640
4641         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4642 }
4643
4644 #[test]
4645 fn test_simple_manager_serialize_deserialize() {
4646         let chanmon_cfgs = create_chanmon_cfgs(2);
4647         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4648         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4649         let logger: test_utils::TestLogger;
4650         let fee_estimator: test_utils::TestFeeEstimator;
4651         let persister: test_utils::TestPersister;
4652         let new_chain_monitor: test_utils::TestChainMonitor;
4653         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4654         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4655         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4656
4657         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4658         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4659
4660         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4661
4662         let nodes_0_serialized = nodes[0].node.encode();
4663         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4664         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4665
4666         logger = test_utils::TestLogger::new();
4667         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4668         persister = test_utils::TestPersister::new();
4669         let keys_manager = &chanmon_cfgs[0].keys_manager;
4670         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4671         nodes[0].chain_monitor = &new_chain_monitor;
4672         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4673         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4674                 &mut chan_0_monitor_read, keys_manager).unwrap();
4675         assert!(chan_0_monitor_read.is_empty());
4676
4677         let mut nodes_0_read = &nodes_0_serialized[..];
4678         let (_, nodes_0_deserialized_tmp) = {
4679                 let mut channel_monitors = HashMap::new();
4680                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4681                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4682                         default_config: UserConfig::default(),
4683                         keys_manager,
4684                         fee_estimator: &fee_estimator,
4685                         chain_monitor: nodes[0].chain_monitor,
4686                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4687                         logger: &logger,
4688                         channel_monitors,
4689                 }).unwrap()
4690         };
4691         nodes_0_deserialized = nodes_0_deserialized_tmp;
4692         assert!(nodes_0_read.is_empty());
4693
4694         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4695         nodes[0].node = &nodes_0_deserialized;
4696         check_added_monitors!(nodes[0], 1);
4697
4698         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4699
4700         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4701         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4702 }
4703
4704 #[test]
4705 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4706         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4707         let chanmon_cfgs = create_chanmon_cfgs(4);
4708         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4709         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4710         let logger: test_utils::TestLogger;
4711         let fee_estimator: test_utils::TestFeeEstimator;
4712         let persister: test_utils::TestPersister;
4713         let new_chain_monitor: test_utils::TestChainMonitor;
4714         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4715         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4716         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4717         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4718         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4719
4720         let mut node_0_stale_monitors_serialized = Vec::new();
4721         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4722                 let mut writer = test_utils::TestVecWriter(Vec::new());
4723                 monitor.1.write(&mut writer).unwrap();
4724                 node_0_stale_monitors_serialized.push(writer.0);
4725         }
4726
4727         let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4728
4729         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4730         let nodes_0_serialized = nodes[0].node.encode();
4731
4732         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4733         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4734         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4735         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4736
4737         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4738         // nodes[3])
4739         let mut node_0_monitors_serialized = Vec::new();
4740         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4741                 let mut writer = test_utils::TestVecWriter(Vec::new());
4742                 monitor.1.write(&mut writer).unwrap();
4743                 node_0_monitors_serialized.push(writer.0);
4744         }
4745
4746         logger = test_utils::TestLogger::new();
4747         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4748         persister = test_utils::TestPersister::new();
4749         let keys_manager = &chanmon_cfgs[0].keys_manager;
4750         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4751         nodes[0].chain_monitor = &new_chain_monitor;
4752
4753
4754         let mut node_0_stale_monitors = Vec::new();
4755         for serialized in node_0_stale_monitors_serialized.iter() {
4756                 let mut read = &serialized[..];
4757                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4758                 assert!(read.is_empty());
4759                 node_0_stale_monitors.push(monitor);
4760         }
4761
4762         let mut node_0_monitors = Vec::new();
4763         for serialized in node_0_monitors_serialized.iter() {
4764                 let mut read = &serialized[..];
4765                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4766                 assert!(read.is_empty());
4767                 node_0_monitors.push(monitor);
4768         }
4769
4770         let mut nodes_0_read = &nodes_0_serialized[..];
4771         if let Err(msgs::DecodeError::InvalidValue) =
4772                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4773                 default_config: UserConfig::default(),
4774                 keys_manager,
4775                 fee_estimator: &fee_estimator,
4776                 chain_monitor: nodes[0].chain_monitor,
4777                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4778                 logger: &logger,
4779                 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4780         }) { } else {
4781                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4782         };
4783
4784         let mut nodes_0_read = &nodes_0_serialized[..];
4785         let (_, nodes_0_deserialized_tmp) =
4786                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4787                 default_config: UserConfig::default(),
4788                 keys_manager,
4789                 fee_estimator: &fee_estimator,
4790                 chain_monitor: nodes[0].chain_monitor,
4791                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4792                 logger: &logger,
4793                 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4794         }).unwrap();
4795         nodes_0_deserialized = nodes_0_deserialized_tmp;
4796         assert!(nodes_0_read.is_empty());
4797
4798         { // Channel close should result in a commitment tx
4799                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4800                 assert_eq!(txn.len(), 1);
4801                 check_spends!(txn[0], funding_tx);
4802                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4803         }
4804
4805         for monitor in node_0_monitors.drain(..) {
4806                 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4807                 check_added_monitors!(nodes[0], 1);
4808         }
4809         nodes[0].node = &nodes_0_deserialized;
4810
4811         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4812         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4813         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4814         //... and we can even still claim the payment!
4815         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4816
4817         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4818         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4819         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4820         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4821         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4822         assert_eq!(msg_events.len(), 1);
4823         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4824                 match action {
4825                         &ErrorAction::SendErrorMessage { ref msg } => {
4826                                 assert_eq!(msg.channel_id, channel_id);
4827                         },
4828                         _ => panic!("Unexpected event!"),
4829                 }
4830         }
4831 }
4832
4833 macro_rules! check_spendable_outputs {
4834         ($node: expr, $keysinterface: expr) => {
4835                 {
4836                         let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4837                         let mut txn = Vec::new();
4838                         let mut all_outputs = Vec::new();
4839                         let secp_ctx = Secp256k1::new();
4840                         for event in events.drain(..) {
4841                                 match event {
4842                                         Event::SpendableOutputs { mut outputs } => {
4843                                                 for outp in outputs.drain(..) {
4844                                                         txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4845                                                         all_outputs.push(outp);
4846                                                 }
4847                                         },
4848                                         _ => panic!("Unexpected event"),
4849                                 };
4850                         }
4851                         if all_outputs.len() > 1 {
4852                                 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) {
4853                                         txn.push(tx);
4854                                 }
4855                         }
4856                         txn
4857                 }
4858         }
4859 }
4860
4861 #[test]
4862 fn test_claim_sizeable_push_msat() {
4863         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4864         let chanmon_cfgs = create_chanmon_cfgs(2);
4865         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4866         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4867         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4868
4869         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4870         nodes[1].node.force_close_channel(&chan.2).unwrap();
4871         check_closed_broadcast!(nodes[1], true);
4872         check_added_monitors!(nodes[1], 1);
4873         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4874         assert_eq!(node_txn.len(), 1);
4875         check_spends!(node_txn[0], chan.3);
4876         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
4877
4878         mine_transaction(&nodes[1], &node_txn[0]);
4879         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4880
4881         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4882         assert_eq!(spend_txn.len(), 1);
4883         assert_eq!(spend_txn[0].input.len(), 1);
4884         check_spends!(spend_txn[0], node_txn[0]);
4885         assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
4886 }
4887
4888 #[test]
4889 fn test_claim_on_remote_sizeable_push_msat() {
4890         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4891         // to_remote output is encumbered by a P2WPKH
4892         let chanmon_cfgs = create_chanmon_cfgs(2);
4893         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4894         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4895         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4896
4897         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4898         nodes[0].node.force_close_channel(&chan.2).unwrap();
4899         check_closed_broadcast!(nodes[0], true);
4900         check_added_monitors!(nodes[0], 1);
4901
4902         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4903         assert_eq!(node_txn.len(), 1);
4904         check_spends!(node_txn[0], chan.3);
4905         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
4906
4907         mine_transaction(&nodes[1], &node_txn[0]);
4908         check_closed_broadcast!(nodes[1], true);
4909         check_added_monitors!(nodes[1], 1);
4910         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4911
4912         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4913         assert_eq!(spend_txn.len(), 1);
4914         check_spends!(spend_txn[0], node_txn[0]);
4915 }
4916
4917 #[test]
4918 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4919         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4920         // to_remote output is encumbered by a P2WPKH
4921
4922         let chanmon_cfgs = create_chanmon_cfgs(2);
4923         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4924         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4925         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4926
4927         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4928         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4929         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4930         assert_eq!(revoked_local_txn[0].input.len(), 1);
4931         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4932
4933         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4934         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4935         check_closed_broadcast!(nodes[1], true);
4936         check_added_monitors!(nodes[1], 1);
4937
4938         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4939         mine_transaction(&nodes[1], &node_txn[0]);
4940         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4941
4942         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4943         assert_eq!(spend_txn.len(), 3);
4944         check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4945         check_spends!(spend_txn[1], node_txn[0]);
4946         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4947 }
4948
4949 #[test]
4950 fn test_static_spendable_outputs_preimage_tx() {
4951         let chanmon_cfgs = create_chanmon_cfgs(2);
4952         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4953         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4954         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4955
4956         // Create some initial channels
4957         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4958
4959         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4960
4961         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4962         assert_eq!(commitment_tx[0].input.len(), 1);
4963         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4964
4965         // Settle A's commitment tx on B's chain
4966         assert!(nodes[1].node.claim_funds(payment_preimage));
4967         check_added_monitors!(nodes[1], 1);
4968         mine_transaction(&nodes[1], &commitment_tx[0]);
4969         check_added_monitors!(nodes[1], 1);
4970         let events = nodes[1].node.get_and_clear_pending_msg_events();
4971         match events[0] {
4972                 MessageSendEvent::UpdateHTLCs { .. } => {},
4973                 _ => panic!("Unexpected event"),
4974         }
4975         match events[1] {
4976                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4977                 _ => panic!("Unexepected event"),
4978         }
4979
4980         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4981         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4982         assert_eq!(node_txn.len(), 3);
4983         check_spends!(node_txn[0], commitment_tx[0]);
4984         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4985         check_spends!(node_txn[1], chan_1.3);
4986         check_spends!(node_txn[2], node_txn[1]);
4987
4988         mine_transaction(&nodes[1], &node_txn[0]);
4989         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4990
4991         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4992         assert_eq!(spend_txn.len(), 1);
4993         check_spends!(spend_txn[0], node_txn[0]);
4994 }
4995
4996 #[test]
4997 fn test_static_spendable_outputs_timeout_tx() {
4998         let chanmon_cfgs = create_chanmon_cfgs(2);
4999         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5000         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5001         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5002
5003         // Create some initial channels
5004         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5005
5006         // Rebalance the network a bit by relaying one payment through all the channels ...
5007         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5008
5009         let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
5010
5011         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5012         assert_eq!(commitment_tx[0].input.len(), 1);
5013         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
5014
5015         // Settle A's commitment tx on B' chain
5016         mine_transaction(&nodes[1], &commitment_tx[0]);
5017         check_added_monitors!(nodes[1], 1);
5018         let events = nodes[1].node.get_and_clear_pending_msg_events();
5019         match events[0] {
5020                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5021                 _ => panic!("Unexpected event"),
5022         }
5023         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5024
5025         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
5026         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
5027         assert_eq!(node_txn.len(), 2); // ChannelManager : 1 local commitent tx, ChannelMonitor: timeout tx
5028         check_spends!(node_txn[0], chan_1.3.clone());
5029         check_spends!(node_txn[1],  commitment_tx[0].clone());
5030         assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5031
5032         mine_transaction(&nodes[1], &node_txn[1]);
5033         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5034         expect_payment_failed!(nodes[1], our_payment_hash, true);
5035
5036         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5037         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
5038         check_spends!(spend_txn[0], commitment_tx[0]);
5039         check_spends!(spend_txn[1], node_txn[1]);
5040         check_spends!(spend_txn[2], node_txn[1], commitment_tx[0]); // All outputs
5041 }
5042
5043 #[test]
5044 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
5045         let chanmon_cfgs = create_chanmon_cfgs(2);
5046         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5047         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5048         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5049
5050         // Create some initial channels
5051         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5052
5053         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5054         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5055         assert_eq!(revoked_local_txn[0].input.len(), 1);
5056         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5057
5058         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5059
5060         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5061         check_closed_broadcast!(nodes[1], true);
5062         check_added_monitors!(nodes[1], 1);
5063
5064         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5065         assert_eq!(node_txn.len(), 2);
5066         assert_eq!(node_txn[0].input.len(), 2);
5067         check_spends!(node_txn[0], revoked_local_txn[0]);
5068
5069         mine_transaction(&nodes[1], &node_txn[0]);
5070         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5071
5072         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5073         assert_eq!(spend_txn.len(), 1);
5074         check_spends!(spend_txn[0], node_txn[0]);
5075 }
5076
5077 #[test]
5078 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5079         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5080         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
5081         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5082         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5083         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5084
5085         // Create some initial channels
5086         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5087
5088         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5089         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5090         assert_eq!(revoked_local_txn[0].input.len(), 1);
5091         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5092
5093         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5094
5095         // A will generate HTLC-Timeout from revoked commitment tx
5096         mine_transaction(&nodes[0], &revoked_local_txn[0]);
5097         check_closed_broadcast!(nodes[0], true);
5098         check_added_monitors!(nodes[0], 1);
5099         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5100
5101         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5102         assert_eq!(revoked_htlc_txn.len(), 2);
5103         check_spends!(revoked_htlc_txn[0], chan_1.3);
5104         assert_eq!(revoked_htlc_txn[1].input.len(), 1);
5105         assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5106         check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
5107         assert_ne!(revoked_htlc_txn[1].lock_time, 0); // HTLC-Timeout
5108
5109         // B will generate justice tx from A's revoked commitment/HTLC tx
5110         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5111         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
5112         check_closed_broadcast!(nodes[1], true);
5113         check_added_monitors!(nodes[1], 1);
5114
5115         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5116         assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
5117         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5118         // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
5119         // transactions next...
5120         assert_eq!(node_txn[0].input.len(), 3);
5121         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
5122
5123         assert_eq!(node_txn[1].input.len(), 2);
5124         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
5125         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
5126                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5127         } else {
5128                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
5129                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5130         }
5131
5132         assert_eq!(node_txn[2].input.len(), 1);
5133         check_spends!(node_txn[2], chan_1.3);
5134
5135         mine_transaction(&nodes[1], &node_txn[1]);
5136         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5137
5138         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5139         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5140         assert_eq!(spend_txn.len(), 1);
5141         assert_eq!(spend_txn[0].input.len(), 1);
5142         check_spends!(spend_txn[0], node_txn[1]);
5143 }
5144
5145 #[test]
5146 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5147         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5148         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
5149         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5150         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5151         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5152
5153         // Create some initial channels
5154         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5155
5156         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5157         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5158         assert_eq!(revoked_local_txn[0].input.len(), 1);
5159         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5160
5161         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5162         assert_eq!(revoked_local_txn[0].output.len(), 2);
5163
5164         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5165
5166         // B will generate HTLC-Success from revoked commitment tx
5167         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5168         check_closed_broadcast!(nodes[1], true);
5169         check_added_monitors!(nodes[1], 1);
5170         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5171
5172         assert_eq!(revoked_htlc_txn.len(), 2);
5173         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5174         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5175         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5176
5177         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5178         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5179         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5180
5181         // A will generate justice tx from B's revoked commitment/HTLC tx
5182         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5183         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5184         check_closed_broadcast!(nodes[0], true);
5185         check_added_monitors!(nodes[0], 1);
5186
5187         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5188         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5189
5190         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5191         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5192         // transactions next...
5193         assert_eq!(node_txn[0].input.len(), 2);
5194         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5195         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5196                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5197         } else {
5198                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5199                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5200         }
5201
5202         assert_eq!(node_txn[1].input.len(), 1);
5203         check_spends!(node_txn[1], revoked_htlc_txn[0]);
5204
5205         check_spends!(node_txn[2], chan_1.3);
5206
5207         mine_transaction(&nodes[0], &node_txn[1]);
5208         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5209
5210         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5211         // didn't try to generate any new transactions.
5212
5213         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5214         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5215         assert_eq!(spend_txn.len(), 3);
5216         assert_eq!(spend_txn[0].input.len(), 1);
5217         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5218         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5219         check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5220         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5221 }
5222
5223 #[test]
5224 fn test_onchain_to_onchain_claim() {
5225         // Test that in case of channel closure, we detect the state of output and claim HTLC
5226         // on downstream peer's remote commitment tx.
5227         // First, have C claim an HTLC against its own latest commitment transaction.
5228         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5229         // channel.
5230         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5231         // gets broadcast.
5232
5233         let chanmon_cfgs = create_chanmon_cfgs(3);
5234         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5235         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5236         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5237
5238         // Create some initial channels
5239         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5240         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5241
5242         // Ensure all nodes are at the same height
5243         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5244         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5245         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5246         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5247
5248         // Rebalance the network a bit by relaying one payment through all the channels ...
5249         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5250         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5251
5252         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5253         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5254         check_spends!(commitment_tx[0], chan_2.3);
5255         nodes[2].node.claim_funds(payment_preimage);
5256         check_added_monitors!(nodes[2], 1);
5257         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5258         assert!(updates.update_add_htlcs.is_empty());
5259         assert!(updates.update_fail_htlcs.is_empty());
5260         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5261         assert!(updates.update_fail_malformed_htlcs.is_empty());
5262
5263         mine_transaction(&nodes[2], &commitment_tx[0]);
5264         check_closed_broadcast!(nodes[2], true);
5265         check_added_monitors!(nodes[2], 1);
5266
5267         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5268         assert_eq!(c_txn.len(), 3);
5269         assert_eq!(c_txn[0], c_txn[2]);
5270         assert_eq!(commitment_tx[0], c_txn[1]);
5271         check_spends!(c_txn[1], chan_2.3);
5272         check_spends!(c_txn[2], c_txn[1]);
5273         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5274         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5275         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5276         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5277
5278         // 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
5279         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5280         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5281         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5282         {
5283                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5284                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx
5285                 assert_eq!(b_txn.len(), 2);
5286                 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
5287                 check_spends!(b_txn[1], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5288                 assert_eq!(b_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5289                 assert!(b_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5290                 assert_ne!(b_txn[1].lock_time, 0); // Timeout tx
5291                 b_txn.clear();
5292         }
5293         check_added_monitors!(nodes[1], 1);
5294         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5295         assert_eq!(msg_events.len(), 3);
5296         check_added_monitors!(nodes[1], 1);
5297         match msg_events[0] {
5298                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5299                 _ => panic!("Unexpected event"),
5300         }
5301         match msg_events[1] {
5302                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5303                 _ => panic!("Unexpected event"),
5304         }
5305         match msg_events[2] {
5306                 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, .. } } => {
5307                         assert!(update_add_htlcs.is_empty());
5308                         assert!(update_fail_htlcs.is_empty());
5309                         assert_eq!(update_fulfill_htlcs.len(), 1);
5310                         assert!(update_fail_malformed_htlcs.is_empty());
5311                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5312                 },
5313                 _ => panic!("Unexpected event"),
5314         };
5315         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5316         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5317         mine_transaction(&nodes[1], &commitment_tx[0]);
5318         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5319         // ChannelMonitor: HTLC-Success tx + HTLC-Timeout RBF Bump, ChannelManager: local commitment tx + HTLC-Success tx
5320         assert_eq!(b_txn.len(), 4);
5321         check_spends!(b_txn[2], chan_1.3);
5322         check_spends!(b_txn[3], b_txn[2]);
5323         let (htlc_success_claim, htlc_timeout_bumped) =
5324                 if b_txn[0].input[0].previous_output.txid == commitment_tx[0].txid()
5325                         { (&b_txn[0], &b_txn[1]) } else { (&b_txn[1], &b_txn[0]) };
5326         check_spends!(htlc_success_claim, commitment_tx[0]);
5327         assert_eq!(htlc_success_claim.input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5328         assert!(htlc_success_claim.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5329         assert_eq!(htlc_success_claim.lock_time, 0); // Success tx
5330         check_spends!(htlc_timeout_bumped, c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5331         assert_ne!(htlc_timeout_bumped.lock_time, 0); // Success tx
5332
5333         check_closed_broadcast!(nodes[1], true);
5334         check_added_monitors!(nodes[1], 1);
5335 }
5336
5337 #[test]
5338 fn test_duplicate_payment_hash_one_failure_one_success() {
5339         // Topology : A --> B --> C --> D
5340         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5341         // Note that because C will refuse to generate two payment secrets for the same payment hash,
5342         // we forward one of the payments onwards to D.
5343         let chanmon_cfgs = create_chanmon_cfgs(4);
5344         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5345         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
5346         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5347
5348         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5349         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5350         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5351
5352         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5353         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5354         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5355         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5356         connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
5357
5358         let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5359
5360         let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5361         // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5362         // script push size limit so that the below script length checks match
5363         // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5364         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
5365                 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV - 40, nodes[0].logger).unwrap();
5366         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5367
5368         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5369         assert_eq!(commitment_txn[0].input.len(), 1);
5370         check_spends!(commitment_txn[0], chan_2.3);
5371
5372         mine_transaction(&nodes[1], &commitment_txn[0]);
5373         check_closed_broadcast!(nodes[1], true);
5374         check_added_monitors!(nodes[1], 1);
5375         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
5376
5377         let htlc_timeout_tx;
5378         { // Extract one of the two HTLC-Timeout transaction
5379                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5380                 // ChannelMonitor: timeout tx * 3, ChannelManager: local commitment tx
5381                 assert_eq!(node_txn.len(), 4);
5382                 check_spends!(node_txn[0], chan_2.3);
5383
5384                 check_spends!(node_txn[1], commitment_txn[0]);
5385                 assert_eq!(node_txn[1].input.len(), 1);
5386                 check_spends!(node_txn[2], commitment_txn[0]);
5387                 assert_eq!(node_txn[2].input.len(), 1);
5388                 assert_eq!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
5389                 check_spends!(node_txn[3], commitment_txn[0]);
5390                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[3].input[0].previous_output);
5391
5392                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5393                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5394                 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5395                 htlc_timeout_tx = node_txn[1].clone();
5396         }
5397
5398         nodes[2].node.claim_funds(our_payment_preimage);
5399         mine_transaction(&nodes[2], &commitment_txn[0]);
5400         check_added_monitors!(nodes[2], 2);
5401         let events = nodes[2].node.get_and_clear_pending_msg_events();
5402         match events[0] {
5403                 MessageSendEvent::UpdateHTLCs { .. } => {},
5404                 _ => panic!("Unexpected event"),
5405         }
5406         match events[1] {
5407                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5408                 _ => panic!("Unexepected event"),
5409         }
5410         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5411         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)
5412         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5413         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5414         assert_eq!(htlc_success_txn[0].input.len(), 1);
5415         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5416         assert_eq!(htlc_success_txn[1].input.len(), 1);
5417         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5418         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5419         assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5420         assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5421         assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5422         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5423
5424         mine_transaction(&nodes[1], &htlc_timeout_tx);
5425         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5426         expect_pending_htlcs_forwardable!(nodes[1]);
5427         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5428         assert!(htlc_updates.update_add_htlcs.is_empty());
5429         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5430         let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5431         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5432         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5433         check_added_monitors!(nodes[1], 1);
5434
5435         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5436         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5437         {
5438                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5439                 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, true);
5440         }
5441         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5442
5443         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5444         mine_transaction(&nodes[1], &htlc_success_txn[0]);
5445         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5446         assert!(updates.update_add_htlcs.is_empty());
5447         assert!(updates.update_fail_htlcs.is_empty());
5448         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5449         assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5450         assert!(updates.update_fail_malformed_htlcs.is_empty());
5451         check_added_monitors!(nodes[1], 1);
5452
5453         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5454         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5455
5456         let events = nodes[0].node.get_and_clear_pending_events();
5457         match events[0] {
5458                 Event::PaymentSent { ref payment_preimage } => {
5459                         assert_eq!(*payment_preimage, our_payment_preimage);
5460                 }
5461                 _ => panic!("Unexpected event"),
5462         }
5463 }
5464
5465 #[test]
5466 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5467         let chanmon_cfgs = create_chanmon_cfgs(2);
5468         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5469         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5470         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5471
5472         // Create some initial channels
5473         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5474
5475         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5476         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5477         assert_eq!(local_txn.len(), 1);
5478         assert_eq!(local_txn[0].input.len(), 1);
5479         check_spends!(local_txn[0], chan_1.3);
5480
5481         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5482         nodes[1].node.claim_funds(payment_preimage);
5483         check_added_monitors!(nodes[1], 1);
5484         mine_transaction(&nodes[1], &local_txn[0]);
5485         check_added_monitors!(nodes[1], 1);
5486         let events = nodes[1].node.get_and_clear_pending_msg_events();
5487         match events[0] {
5488                 MessageSendEvent::UpdateHTLCs { .. } => {},
5489                 _ => panic!("Unexpected event"),
5490         }
5491         match events[1] {
5492                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5493                 _ => panic!("Unexepected event"),
5494         }
5495         let node_tx = {
5496                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5497                 assert_eq!(node_txn.len(), 3);
5498                 assert_eq!(node_txn[0], node_txn[2]);
5499                 assert_eq!(node_txn[1], local_txn[0]);
5500                 assert_eq!(node_txn[0].input.len(), 1);
5501                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5502                 check_spends!(node_txn[0], local_txn[0]);
5503                 node_txn[0].clone()
5504         };
5505
5506         mine_transaction(&nodes[1], &node_tx);
5507         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
5508
5509         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5510         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5511         assert_eq!(spend_txn.len(), 1);
5512         assert_eq!(spend_txn[0].input.len(), 1);
5513         check_spends!(spend_txn[0], node_tx);
5514         assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5515 }
5516
5517 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5518         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5519         // unrevoked commitment transaction.
5520         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5521         // a remote RAA before they could be failed backwards (and combinations thereof).
5522         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5523         // use the same payment hashes.
5524         // Thus, we use a six-node network:
5525         //
5526         // A \         / E
5527         //    - C - D -
5528         // B /         \ F
5529         // And test where C fails back to A/B when D announces its latest commitment transaction
5530         let chanmon_cfgs = create_chanmon_cfgs(6);
5531         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5532         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5533         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5534         let logger = test_utils::TestLogger::new();
5535
5536         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5537         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5538         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5539         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5540         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5541
5542         // Rebalance and check output sanity...
5543         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5544         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5545         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5546
5547         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5548         // 0th HTLC:
5549         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
5550         // 1st HTLC:
5551         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
5552         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5553         let our_node_id = &nodes[1].node.get_our_node_id();
5554         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5555         // 2nd HTLC:
5556         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
5557         // 3rd HTLC:
5558         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
5559         // 4th HTLC:
5560         let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5561         // 5th HTLC:
5562         let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5563         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5564         // 6th HTLC:
5565         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());
5566         // 7th HTLC:
5567         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());
5568
5569         // 8th HTLC:
5570         let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5571         // 9th HTLC:
5572         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5573         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
5574
5575         // 10th HTLC:
5576         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
5577         // 11th HTLC:
5578         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5579         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());
5580
5581         // Double-check that six of the new HTLC were added
5582         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5583         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5584         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5585         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5586
5587         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5588         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5589         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5590         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5591         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5592         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5593         check_added_monitors!(nodes[4], 0);
5594         expect_pending_htlcs_forwardable!(nodes[4]);
5595         check_added_monitors!(nodes[4], 1);
5596
5597         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5598         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5599         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5600         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5601         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5602         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5603
5604         // Fail 3rd below-dust and 7th above-dust HTLCs
5605         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5606         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5607         check_added_monitors!(nodes[5], 0);
5608         expect_pending_htlcs_forwardable!(nodes[5]);
5609         check_added_monitors!(nodes[5], 1);
5610
5611         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5612         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5613         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5614         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5615
5616         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5617
5618         expect_pending_htlcs_forwardable!(nodes[3]);
5619         check_added_monitors!(nodes[3], 1);
5620         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5621         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5622         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5623         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5624         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5625         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5626         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5627         if deliver_last_raa {
5628                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5629         } else {
5630                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5631         }
5632
5633         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5634         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5635         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5636         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5637         //
5638         // We now broadcast the latest commitment transaction, which *should* result in failures for
5639         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5640         // the non-broadcast above-dust HTLCs.
5641         //
5642         // Alternatively, we may broadcast the previous commitment transaction, which should only
5643         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5644         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5645
5646         if announce_latest {
5647                 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5648         } else {
5649                 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5650         }
5651         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5652         check_closed_broadcast!(nodes[2], true);
5653         expect_pending_htlcs_forwardable!(nodes[2]);
5654         check_added_monitors!(nodes[2], 3);
5655
5656         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5657         assert_eq!(cs_msgs.len(), 2);
5658         let mut a_done = false;
5659         for msg in cs_msgs {
5660                 match msg {
5661                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5662                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5663                                 // should be failed-backwards here.
5664                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5665                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5666                                         for htlc in &updates.update_fail_htlcs {
5667                                                 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 });
5668                                         }
5669                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5670                                         assert!(!a_done);
5671                                         a_done = true;
5672                                         &nodes[0]
5673                                 } else {
5674                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5675                                         for htlc in &updates.update_fail_htlcs {
5676                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5677                                         }
5678                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5679                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5680                                         &nodes[1]
5681                                 };
5682                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5683                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5684                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5685                                 if announce_latest {
5686                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5687                                         if *node_id == nodes[0].node.get_our_node_id() {
5688                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5689                                         }
5690                                 }
5691                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5692                         },
5693                         _ => panic!("Unexpected event"),
5694                 }
5695         }
5696
5697         let as_events = nodes[0].node.get_and_clear_pending_events();
5698         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5699         let mut as_failds = HashSet::new();
5700         for event in as_events.iter() {
5701                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5702                         assert!(as_failds.insert(*payment_hash));
5703                         if *payment_hash != payment_hash_2 {
5704                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5705                         } else {
5706                                 assert!(!rejected_by_dest);
5707                         }
5708                 } else { panic!("Unexpected event"); }
5709         }
5710         assert!(as_failds.contains(&payment_hash_1));
5711         assert!(as_failds.contains(&payment_hash_2));
5712         if announce_latest {
5713                 assert!(as_failds.contains(&payment_hash_3));
5714                 assert!(as_failds.contains(&payment_hash_5));
5715         }
5716         assert!(as_failds.contains(&payment_hash_6));
5717
5718         let bs_events = nodes[1].node.get_and_clear_pending_events();
5719         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5720         let mut bs_failds = HashSet::new();
5721         for event in bs_events.iter() {
5722                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5723                         assert!(bs_failds.insert(*payment_hash));
5724                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5725                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5726                         } else {
5727                                 assert!(!rejected_by_dest);
5728                         }
5729                 } else { panic!("Unexpected event"); }
5730         }
5731         assert!(bs_failds.contains(&payment_hash_1));
5732         assert!(bs_failds.contains(&payment_hash_2));
5733         if announce_latest {
5734                 assert!(bs_failds.contains(&payment_hash_4));
5735         }
5736         assert!(bs_failds.contains(&payment_hash_5));
5737
5738         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5739         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5740         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5741         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5742         // PaymentFailureNetworkUpdates.
5743         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5744         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5745         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5746         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5747         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5748                 match event {
5749                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5750                         _ => panic!("Unexpected event"),
5751                 }
5752         }
5753 }
5754
5755 #[test]
5756 fn test_fail_backwards_latest_remote_announce_a() {
5757         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5758 }
5759
5760 #[test]
5761 fn test_fail_backwards_latest_remote_announce_b() {
5762         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5763 }
5764
5765 #[test]
5766 fn test_fail_backwards_previous_remote_announce() {
5767         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5768         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5769         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5770 }
5771
5772 #[test]
5773 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5774         let chanmon_cfgs = create_chanmon_cfgs(2);
5775         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5776         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5777         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5778
5779         // Create some initial channels
5780         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5781
5782         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5783         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5784         assert_eq!(local_txn[0].input.len(), 1);
5785         check_spends!(local_txn[0], chan_1.3);
5786
5787         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5788         mine_transaction(&nodes[0], &local_txn[0]);
5789         check_closed_broadcast!(nodes[0], true);
5790         check_added_monitors!(nodes[0], 1);
5791         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5792
5793         let htlc_timeout = {
5794                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5795                 assert_eq!(node_txn.len(), 2);
5796                 check_spends!(node_txn[0], chan_1.3);
5797                 assert_eq!(node_txn[1].input.len(), 1);
5798                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5799                 check_spends!(node_txn[1], local_txn[0]);
5800                 node_txn[1].clone()
5801         };
5802
5803         mine_transaction(&nodes[0], &htlc_timeout);
5804         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5805         expect_payment_failed!(nodes[0], our_payment_hash, true);
5806
5807         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5808         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5809         assert_eq!(spend_txn.len(), 3);
5810         check_spends!(spend_txn[0], local_txn[0]);
5811         assert_eq!(spend_txn[1].input.len(), 1);
5812         check_spends!(spend_txn[1], htlc_timeout);
5813         assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5814         assert_eq!(spend_txn[2].input.len(), 2);
5815         check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5816         assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5817                 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5818 }
5819
5820 #[test]
5821 fn test_key_derivation_params() {
5822         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5823         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5824         // let us re-derive the channel key set to then derive a delayed_payment_key.
5825
5826         let chanmon_cfgs = create_chanmon_cfgs(3);
5827
5828         // We manually create the node configuration to backup the seed.
5829         let seed = [42; 32];
5830         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5831         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);
5832         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 };
5833         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5834         node_cfgs.remove(0);
5835         node_cfgs.insert(0, node);
5836
5837         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5838         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5839
5840         // Create some initial channels
5841         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5842         // for node 0
5843         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5844         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5845         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5846
5847         // Ensure all nodes are at the same height
5848         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5849         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5850         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5851         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5852
5853         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5854         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5855         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5856         assert_eq!(local_txn_1[0].input.len(), 1);
5857         check_spends!(local_txn_1[0], chan_1.3);
5858
5859         // We check funding pubkey are unique
5860         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]));
5861         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]));
5862         if from_0_funding_key_0 == from_1_funding_key_0
5863             || from_0_funding_key_0 == from_1_funding_key_1
5864             || from_0_funding_key_1 == from_1_funding_key_0
5865             || from_0_funding_key_1 == from_1_funding_key_1 {
5866                 panic!("Funding pubkeys aren't unique");
5867         }
5868
5869         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5870         mine_transaction(&nodes[0], &local_txn_1[0]);
5871         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5872         check_closed_broadcast!(nodes[0], true);
5873         check_added_monitors!(nodes[0], 1);
5874
5875         let htlc_timeout = {
5876                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5877                 assert_eq!(node_txn[1].input.len(), 1);
5878                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5879                 check_spends!(node_txn[1], local_txn_1[0]);
5880                 node_txn[1].clone()
5881         };
5882
5883         mine_transaction(&nodes[0], &htlc_timeout);
5884         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5885         expect_payment_failed!(nodes[0], our_payment_hash, true);
5886
5887         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5888         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5889         let spend_txn = check_spendable_outputs!(nodes[0], new_keys_manager);
5890         assert_eq!(spend_txn.len(), 3);
5891         check_spends!(spend_txn[0], local_txn_1[0]);
5892         assert_eq!(spend_txn[1].input.len(), 1);
5893         check_spends!(spend_txn[1], htlc_timeout);
5894         assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5895         assert_eq!(spend_txn[2].input.len(), 2);
5896         check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5897         assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5898                 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5899 }
5900
5901 #[test]
5902 fn test_static_output_closing_tx() {
5903         let chanmon_cfgs = create_chanmon_cfgs(2);
5904         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5905         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5906         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5907
5908         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5909
5910         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5911         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5912
5913         mine_transaction(&nodes[0], &closing_tx);
5914         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5915
5916         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5917         assert_eq!(spend_txn.len(), 1);
5918         check_spends!(spend_txn[0], closing_tx);
5919
5920         mine_transaction(&nodes[1], &closing_tx);
5921         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5922
5923         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5924         assert_eq!(spend_txn.len(), 1);
5925         check_spends!(spend_txn[0], closing_tx);
5926 }
5927
5928 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5929         let chanmon_cfgs = create_chanmon_cfgs(2);
5930         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5931         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5932         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5933         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5934
5935         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5936
5937         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5938         // present in B's local commitment transaction, but none of A's commitment transactions.
5939         assert!(nodes[1].node.claim_funds(our_payment_preimage));
5940         check_added_monitors!(nodes[1], 1);
5941
5942         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5943         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5944         let events = nodes[0].node.get_and_clear_pending_events();
5945         assert_eq!(events.len(), 1);
5946         match events[0] {
5947                 Event::PaymentSent { payment_preimage } => {
5948                         assert_eq!(payment_preimage, our_payment_preimage);
5949                 },
5950                 _ => panic!("Unexpected event"),
5951         }
5952
5953         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5954         check_added_monitors!(nodes[0], 1);
5955         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5956         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5957         check_added_monitors!(nodes[1], 1);
5958
5959         let starting_block = nodes[1].best_block_info();
5960         let mut block = Block {
5961                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5962                 txdata: vec![],
5963         };
5964         for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5965                 connect_block(&nodes[1], &block);
5966                 block.header.prev_blockhash = block.block_hash();
5967         }
5968         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5969         check_closed_broadcast!(nodes[1], true);
5970         check_added_monitors!(nodes[1], 1);
5971 }
5972
5973 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5974         let chanmon_cfgs = create_chanmon_cfgs(2);
5975         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5976         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5977         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5978         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5979         let logger = test_utils::TestLogger::new();
5980
5981         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
5982         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5983         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV, &logger).unwrap();
5984         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5985         check_added_monitors!(nodes[0], 1);
5986
5987         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5988
5989         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5990         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5991         // to "time out" the HTLC.
5992
5993         let starting_block = nodes[1].best_block_info();
5994         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5995
5996         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5997                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5998                 header.prev_blockhash = header.block_hash();
5999         }
6000         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6001         check_closed_broadcast!(nodes[0], true);
6002         check_added_monitors!(nodes[0], 1);
6003 }
6004
6005 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
6006         let chanmon_cfgs = create_chanmon_cfgs(3);
6007         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6008         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6009         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6010         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6011
6012         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
6013         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
6014         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
6015         // actually revoked.
6016         let htlc_value = if use_dust { 50000 } else { 3000000 };
6017         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
6018         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
6019         expect_pending_htlcs_forwardable!(nodes[1]);
6020         check_added_monitors!(nodes[1], 1);
6021
6022         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6023         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
6024         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
6025         check_added_monitors!(nodes[0], 1);
6026         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6027         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
6028         check_added_monitors!(nodes[1], 1);
6029         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
6030         check_added_monitors!(nodes[1], 1);
6031         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6032
6033         if check_revoke_no_close {
6034                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
6035                 check_added_monitors!(nodes[0], 1);
6036         }
6037
6038         let starting_block = nodes[1].best_block_info();
6039         let mut block = Block {
6040                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6041                 txdata: vec![],
6042         };
6043         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
6044                 connect_block(&nodes[0], &block);
6045                 block.header.prev_blockhash = block.block_hash();
6046         }
6047         if !check_revoke_no_close {
6048                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6049                 check_closed_broadcast!(nodes[0], true);
6050                 check_added_monitors!(nodes[0], 1);
6051         } else {
6052                 expect_payment_failed!(nodes[0], our_payment_hash, true);
6053         }
6054 }
6055
6056 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
6057 // There are only a few cases to test here:
6058 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
6059 //    broadcastable commitment transactions result in channel closure,
6060 //  * its included in an unrevoked-but-previous remote commitment transaction,
6061 //  * its included in the latest remote or local commitment transactions.
6062 // We test each of the three possible commitment transactions individually and use both dust and
6063 // non-dust HTLCs.
6064 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
6065 // assume they are handled the same across all six cases, as both outbound and inbound failures are
6066 // tested for at least one of the cases in other tests.
6067 #[test]
6068 fn htlc_claim_single_commitment_only_a() {
6069         do_htlc_claim_local_commitment_only(true);
6070         do_htlc_claim_local_commitment_only(false);
6071
6072         do_htlc_claim_current_remote_commitment_only(true);
6073         do_htlc_claim_current_remote_commitment_only(false);
6074 }
6075
6076 #[test]
6077 fn htlc_claim_single_commitment_only_b() {
6078         do_htlc_claim_previous_remote_commitment_only(true, false);
6079         do_htlc_claim_previous_remote_commitment_only(false, false);
6080         do_htlc_claim_previous_remote_commitment_only(true, true);
6081         do_htlc_claim_previous_remote_commitment_only(false, true);
6082 }
6083
6084 #[test]
6085 #[should_panic]
6086 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6087         let chanmon_cfgs = create_chanmon_cfgs(2);
6088         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6089         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6090         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6091         //Force duplicate channel ids
6092         for node in nodes.iter() {
6093                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6094         }
6095
6096         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6097         let channel_value_satoshis=10000;
6098         let push_msat=10001;
6099         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6100         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6101         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6102
6103         //Create a second channel with a channel_id collision
6104         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6105 }
6106
6107 #[test]
6108 fn bolt2_open_channel_sending_node_checks_part2() {
6109         let chanmon_cfgs = create_chanmon_cfgs(2);
6110         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6111         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6112         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6113
6114         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6115         let channel_value_satoshis=2^24;
6116         let push_msat=10001;
6117         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6118
6119         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6120         let channel_value_satoshis=10000;
6121         // Test when push_msat is equal to 1000 * funding_satoshis.
6122         let push_msat=1000*channel_value_satoshis+1;
6123         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6124
6125         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6126         let channel_value_satoshis=10000;
6127         let push_msat=10001;
6128         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
6129         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6130         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6131
6132         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6133         // 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
6134         assert!(node0_to_1_send_open_channel.channel_flags<=1);
6135
6136         // 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.
6137         assert!(BREAKDOWN_TIMEOUT>0);
6138         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6139
6140         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6141         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6142         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6143
6144         // 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.
6145         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6146         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6147         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6148         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6149         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6150 }
6151
6152 #[test]
6153 fn bolt2_open_channel_sane_dust_limit() {
6154         let chanmon_cfgs = create_chanmon_cfgs(2);
6155         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6156         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6157         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6158
6159         let channel_value_satoshis=1000000;
6160         let push_msat=10001;
6161         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6162         let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6163         node0_to_1_send_open_channel.dust_limit_satoshis = 661;
6164         node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
6165
6166         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6167         let events = nodes[1].node.get_and_clear_pending_msg_events();
6168         let err_msg = match events[0] {
6169                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
6170                         msg.clone()
6171                 },
6172                 _ => panic!("Unexpected event"),
6173         };
6174         assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
6175 }
6176
6177 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6178 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6179 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6180 // is no longer affordable once it's freed.
6181 #[test]
6182 fn test_fail_holding_cell_htlc_upon_free() {
6183         let chanmon_cfgs = create_chanmon_cfgs(2);
6184         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6185         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6186         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6187         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6188         let logger = test_utils::TestLogger::new();
6189
6190         // First nodes[0] generates an update_fee, setting the channel's
6191         // pending_update_fee.
6192         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6193         check_added_monitors!(nodes[0], 1);
6194
6195         let events = nodes[0].node.get_and_clear_pending_msg_events();
6196         assert_eq!(events.len(), 1);
6197         let (update_msg, commitment_signed) = match events[0] {
6198                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6199                         (update_fee.as_ref(), commitment_signed)
6200                 },
6201                 _ => panic!("Unexpected event"),
6202         };
6203
6204         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6205
6206         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6207         let channel_reserve = chan_stat.channel_reserve_msat;
6208         let feerate = get_feerate!(nodes[0], chan.2);
6209
6210         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6211         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6212         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6213         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6214         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6215
6216         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6217         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6218         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6219         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6220
6221         // Flush the pending fee update.
6222         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6223         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6224         check_added_monitors!(nodes[1], 1);
6225         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6226         check_added_monitors!(nodes[0], 1);
6227
6228         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6229         // HTLC, but now that the fee has been raised the payment will now fail, causing
6230         // us to surface its failure to the user.
6231         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6232         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6233         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);
6234         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 {}",
6235                 hex::encode(our_payment_hash.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6236         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6237
6238         // Check that the payment failed to be sent out.
6239         let events = nodes[0].node.get_and_clear_pending_events();
6240         assert_eq!(events.len(), 1);
6241         match &events[0] {
6242                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6243                         assert_eq!(our_payment_hash.clone(), *payment_hash);
6244                         assert_eq!(*rejected_by_dest, false);
6245                         assert_eq!(*error_code, None);
6246                         assert_eq!(*error_data, None);
6247                 },
6248                 _ => panic!("Unexpected event"),
6249         }
6250 }
6251
6252 // Test that if multiple HTLCs are released from the holding cell and one is
6253 // valid but the other is no longer valid upon release, the valid HTLC can be
6254 // successfully completed while the other one fails as expected.
6255 #[test]
6256 fn test_free_and_fail_holding_cell_htlcs() {
6257         let chanmon_cfgs = create_chanmon_cfgs(2);
6258         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6259         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6260         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6261         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6262         let logger = test_utils::TestLogger::new();
6263
6264         // First nodes[0] generates an update_fee, setting the channel's
6265         // pending_update_fee.
6266         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6267         check_added_monitors!(nodes[0], 1);
6268
6269         let events = nodes[0].node.get_and_clear_pending_msg_events();
6270         assert_eq!(events.len(), 1);
6271         let (update_msg, commitment_signed) = match events[0] {
6272                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6273                         (update_fee.as_ref(), commitment_signed)
6274                 },
6275                 _ => panic!("Unexpected event"),
6276         };
6277
6278         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6279
6280         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6281         let channel_reserve = chan_stat.channel_reserve_msat;
6282         let feerate = get_feerate!(nodes[0], chan.2);
6283
6284         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6285         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6286         let amt_1 = 20000;
6287         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6288         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6289         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6290         let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], amt_1, TEST_FINAL_CLTV, &logger).unwrap();
6291         let route_2 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], amt_2, TEST_FINAL_CLTV, &logger).unwrap();
6292
6293         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6294         nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6295         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6296         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6297         nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6298         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6299         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6300
6301         // Flush the pending fee update.
6302         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6303         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6304         check_added_monitors!(nodes[1], 1);
6305         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6306         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6307         check_added_monitors!(nodes[0], 2);
6308
6309         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6310         // but now that the fee has been raised the second payment will now fail, causing us
6311         // to surface its failure to the user. The first payment should succeed.
6312         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6313         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6314         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);
6315         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 {}",
6316                 hex::encode(payment_hash_2.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6317         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6318
6319         // Check that the second payment failed to be sent out.
6320         let events = nodes[0].node.get_and_clear_pending_events();
6321         assert_eq!(events.len(), 1);
6322         match &events[0] {
6323                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6324                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6325                         assert_eq!(*rejected_by_dest, false);
6326                         assert_eq!(*error_code, None);
6327                         assert_eq!(*error_data, None);
6328                 },
6329                 _ => panic!("Unexpected event"),
6330         }
6331
6332         // Complete the first payment and the RAA from the fee update.
6333         let (payment_event, send_raa_event) = {
6334                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6335                 assert_eq!(msgs.len(), 2);
6336                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6337         };
6338         let raa = match send_raa_event {
6339                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6340                 _ => panic!("Unexpected event"),
6341         };
6342         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6343         check_added_monitors!(nodes[1], 1);
6344         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6345         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6346         let events = nodes[1].node.get_and_clear_pending_events();
6347         assert_eq!(events.len(), 1);
6348         match events[0] {
6349                 Event::PendingHTLCsForwardable { .. } => {},
6350                 _ => panic!("Unexpected event"),
6351         }
6352         nodes[1].node.process_pending_htlc_forwards();
6353         let events = nodes[1].node.get_and_clear_pending_events();
6354         assert_eq!(events.len(), 1);
6355         match events[0] {
6356                 Event::PaymentReceived { .. } => {},
6357                 _ => panic!("Unexpected event"),
6358         }
6359         nodes[1].node.claim_funds(payment_preimage_1);
6360         check_added_monitors!(nodes[1], 1);
6361         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6362         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6363         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6364         let events = nodes[0].node.get_and_clear_pending_events();
6365         assert_eq!(events.len(), 1);
6366         match events[0] {
6367                 Event::PaymentSent { ref payment_preimage } => {
6368                         assert_eq!(*payment_preimage, payment_preimage_1);
6369                 }
6370                 _ => panic!("Unexpected event"),
6371         }
6372 }
6373
6374 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6375 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6376 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6377 // once it's freed.
6378 #[test]
6379 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6380         let chanmon_cfgs = create_chanmon_cfgs(3);
6381         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6382         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6383         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6384         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6385         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6386         let logger = test_utils::TestLogger::new();
6387
6388         // First nodes[1] generates an update_fee, setting the channel's
6389         // pending_update_fee.
6390         nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6391         check_added_monitors!(nodes[1], 1);
6392
6393         let events = nodes[1].node.get_and_clear_pending_msg_events();
6394         assert_eq!(events.len(), 1);
6395         let (update_msg, commitment_signed) = match events[0] {
6396                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6397                         (update_fee.as_ref(), commitment_signed)
6398                 },
6399                 _ => panic!("Unexpected event"),
6400         };
6401
6402         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6403
6404         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6405         let channel_reserve = chan_stat.channel_reserve_msat;
6406         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6407
6408         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6409         let feemsat = 239;
6410         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6411         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6412         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6413         let payment_event = {
6414                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6415                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6416                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6417                 check_added_monitors!(nodes[0], 1);
6418
6419                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6420                 assert_eq!(events.len(), 1);
6421
6422                 SendEvent::from_event(events.remove(0))
6423         };
6424         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6425         check_added_monitors!(nodes[1], 0);
6426         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6427         expect_pending_htlcs_forwardable!(nodes[1]);
6428
6429         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6430         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6431
6432         // Flush the pending fee update.
6433         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6434         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6435         check_added_monitors!(nodes[2], 1);
6436         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6437         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6438         check_added_monitors!(nodes[1], 2);
6439
6440         // A final RAA message is generated to finalize the fee update.
6441         let events = nodes[1].node.get_and_clear_pending_msg_events();
6442         assert_eq!(events.len(), 1);
6443
6444         let raa_msg = match &events[0] {
6445                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6446                         msg.clone()
6447                 },
6448                 _ => panic!("Unexpected event"),
6449         };
6450
6451         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6452         check_added_monitors!(nodes[2], 1);
6453         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6454
6455         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6456         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6457         assert_eq!(process_htlc_forwards_event.len(), 1);
6458         match &process_htlc_forwards_event[0] {
6459                 &Event::PendingHTLCsForwardable { .. } => {},
6460                 _ => panic!("Unexpected event"),
6461         }
6462
6463         // In response, we call ChannelManager's process_pending_htlc_forwards
6464         nodes[1].node.process_pending_htlc_forwards();
6465         check_added_monitors!(nodes[1], 1);
6466
6467         // This causes the HTLC to be failed backwards.
6468         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6469         assert_eq!(fail_event.len(), 1);
6470         let (fail_msg, commitment_signed) = match &fail_event[0] {
6471                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6472                         assert_eq!(updates.update_add_htlcs.len(), 0);
6473                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6474                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6475                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6476                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6477                 },
6478                 _ => panic!("Unexpected event"),
6479         };
6480
6481         // Pass the failure messages back to nodes[0].
6482         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6483         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6484
6485         // Complete the HTLC failure+removal process.
6486         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6487         check_added_monitors!(nodes[0], 1);
6488         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6489         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6490         check_added_monitors!(nodes[1], 2);
6491         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6492         assert_eq!(final_raa_event.len(), 1);
6493         let raa = match &final_raa_event[0] {
6494                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6495                 _ => panic!("Unexpected event"),
6496         };
6497         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6498         expect_payment_failure_chan_update!(nodes[0], chan_1_2.0.contents.short_channel_id, false);
6499         expect_payment_failed!(nodes[0], our_payment_hash, false);
6500         check_added_monitors!(nodes[0], 1);
6501 }
6502
6503 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6504 // 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.
6505 //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.
6506
6507 #[test]
6508 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6509         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6510         let chanmon_cfgs = create_chanmon_cfgs(2);
6511         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6512         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6513         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6514         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6515
6516         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6517         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6518         let logger = test_utils::TestLogger::new();
6519         let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6520         route.paths[0][0].fee_msat = 100;
6521
6522         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6523                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6524         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6525         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6526 }
6527
6528 #[test]
6529 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6530         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6531         let chanmon_cfgs = create_chanmon_cfgs(2);
6532         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6533         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6534         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6535         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6536         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6537
6538         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6539         let logger = test_utils::TestLogger::new();
6540         let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6541         route.paths[0][0].fee_msat = 0;
6542         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6543                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6544
6545         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6546         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6547 }
6548
6549 #[test]
6550 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6551         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6552         let chanmon_cfgs = create_chanmon_cfgs(2);
6553         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6554         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6555         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6556         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6557
6558         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6559         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6560         let logger = test_utils::TestLogger::new();
6561         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6562         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6563         check_added_monitors!(nodes[0], 1);
6564         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6565         updates.update_add_htlcs[0].amount_msat = 0;
6566
6567         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6568         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6569         check_closed_broadcast!(nodes[1], true).unwrap();
6570         check_added_monitors!(nodes[1], 1);
6571 }
6572
6573 #[test]
6574 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6575         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6576         //It is enforced when constructing a route.
6577         let chanmon_cfgs = create_chanmon_cfgs(2);
6578         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6579         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6580         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6581         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6582         let logger = test_utils::TestLogger::new();
6583
6584         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6585
6586         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6587         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000000, 500000001, &logger).unwrap();
6588         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6589                 assert_eq!(err, &"Channel CLTV overflowed?"));
6590 }
6591
6592 #[test]
6593 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6594         //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.
6595         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6596         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6597         let chanmon_cfgs = create_chanmon_cfgs(2);
6598         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6599         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6600         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6601         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6602         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6603
6604         let logger = test_utils::TestLogger::new();
6605         for i in 0..max_accepted_htlcs {
6606                 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6607                 let payment_event = {
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.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6610                         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6611                         check_added_monitors!(nodes[0], 1);
6612
6613                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6614                         assert_eq!(events.len(), 1);
6615                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6616                                 assert_eq!(htlcs[0].htlc_id, i);
6617                         } else {
6618                                 assert!(false);
6619                         }
6620                         SendEvent::from_event(events.remove(0))
6621                 };
6622                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6623                 check_added_monitors!(nodes[1], 0);
6624                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6625
6626                 expect_pending_htlcs_forwardable!(nodes[1]);
6627                 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6628         }
6629         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6630         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6631         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6632         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6633                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6634
6635         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6636         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6637 }
6638
6639 #[test]
6640 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6641         //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.
6642         let chanmon_cfgs = create_chanmon_cfgs(2);
6643         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6644         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6645         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6646         let channel_value = 100000;
6647         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6648         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6649
6650         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6651
6652         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6653         // Manually create a route over our max in flight (which our router normally automatically
6654         // limits us to.
6655         let route = Route { paths: vec![vec![RouteHop {
6656            pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6657            short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6658            fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6659         }]] };
6660         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6661                 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)));
6662
6663         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6664         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);
6665
6666         send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6667 }
6668
6669 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6670 #[test]
6671 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6672         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6673         let chanmon_cfgs = create_chanmon_cfgs(2);
6674         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6675         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6676         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6677         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6678         let htlc_minimum_msat: u64;
6679         {
6680                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6681                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6682                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6683         }
6684
6685         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6686         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6687         let logger = test_utils::TestLogger::new();
6688         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV, &logger).unwrap();
6689         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6690         check_added_monitors!(nodes[0], 1);
6691         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6692         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6693         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6694         assert!(nodes[1].node.list_channels().is_empty());
6695         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6696         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()));
6697         check_added_monitors!(nodes[1], 1);
6698 }
6699
6700 #[test]
6701 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6702         //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
6703         let chanmon_cfgs = create_chanmon_cfgs(2);
6704         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6705         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6706         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6707         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6708         let logger = test_utils::TestLogger::new();
6709
6710         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6711         let channel_reserve = chan_stat.channel_reserve_msat;
6712         let feerate = get_feerate!(nodes[0], chan.2);
6713         // The 2* and +1 are for the fee spike reserve.
6714         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6715
6716         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6717         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6718         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6719         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6720         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6721         check_added_monitors!(nodes[0], 1);
6722         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6723
6724         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6725         // at this time channel-initiatee receivers are not required to enforce that senders
6726         // respect the fee_spike_reserve.
6727         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6728         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6729
6730         assert!(nodes[1].node.list_channels().is_empty());
6731         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6732         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6733         check_added_monitors!(nodes[1], 1);
6734 }
6735
6736 #[test]
6737 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6738         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6739         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6740         let chanmon_cfgs = create_chanmon_cfgs(2);
6741         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6742         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6743         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6744         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6745         let logger = test_utils::TestLogger::new();
6746
6747         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6748         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6749
6750         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6751         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 3999999, TEST_FINAL_CLTV, &logger).unwrap();
6752
6753         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6754         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6755         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height).unwrap();
6756         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6757
6758         let mut msg = msgs::UpdateAddHTLC {
6759                 channel_id: chan.2,
6760                 htlc_id: 0,
6761                 amount_msat: 1000,
6762                 payment_hash: our_payment_hash,
6763                 cltv_expiry: htlc_cltv,
6764                 onion_routing_packet: onion_packet.clone(),
6765         };
6766
6767         for i in 0..super::channel::OUR_MAX_HTLCS {
6768                 msg.htlc_id = i as u64;
6769                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6770         }
6771         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6772         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6773
6774         assert!(nodes[1].node.list_channels().is_empty());
6775         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6776         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6777         check_added_monitors!(nodes[1], 1);
6778 }
6779
6780 #[test]
6781 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6782         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6783         let chanmon_cfgs = create_chanmon_cfgs(2);
6784         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6785         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6786         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6787         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6788         let logger = test_utils::TestLogger::new();
6789
6790         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6791         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6792         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6793         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6794         check_added_monitors!(nodes[0], 1);
6795         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6796         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6797         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6798
6799         assert!(nodes[1].node.list_channels().is_empty());
6800         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6801         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6802         check_added_monitors!(nodes[1], 1);
6803 }
6804
6805 #[test]
6806 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6807         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6808         let chanmon_cfgs = create_chanmon_cfgs(2);
6809         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6810         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6811         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6812         let logger = test_utils::TestLogger::new();
6813
6814         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6815         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6816         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6817         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6818         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6819         check_added_monitors!(nodes[0], 1);
6820         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6821         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6822         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6823
6824         assert!(nodes[1].node.list_channels().is_empty());
6825         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6826         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6827         check_added_monitors!(nodes[1], 1);
6828 }
6829
6830 #[test]
6831 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6832         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6833         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6834         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6835         let chanmon_cfgs = create_chanmon_cfgs(2);
6836         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6837         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6838         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6839         let logger = test_utils::TestLogger::new();
6840
6841         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6842         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
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.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, 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 updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6848         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6849
6850         //Disconnect and Reconnect
6851         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6852         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6853         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6854         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6855         assert_eq!(reestablish_1.len(), 1);
6856         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6857         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6858         assert_eq!(reestablish_2.len(), 1);
6859         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6860         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6861         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6862         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6863
6864         //Resend HTLC
6865         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6866         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6867         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6868         check_added_monitors!(nodes[1], 1);
6869         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6870
6871         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6872
6873         assert!(nodes[1].node.list_channels().is_empty());
6874         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6875         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6876         check_added_monitors!(nodes[1], 1);
6877 }
6878
6879 #[test]
6880 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6881         //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.
6882
6883         let chanmon_cfgs = create_chanmon_cfgs(2);
6884         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6885         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6886         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6887         let logger = test_utils::TestLogger::new();
6888         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6889         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6890         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6891         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6892         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6893
6894         check_added_monitors!(nodes[0], 1);
6895         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6896         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6897
6898         let update_msg = msgs::UpdateFulfillHTLC{
6899                 channel_id: chan.2,
6900                 htlc_id: 0,
6901                 payment_preimage: our_payment_preimage,
6902         };
6903
6904         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6905
6906         assert!(nodes[0].node.list_channels().is_empty());
6907         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6908         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()));
6909         check_added_monitors!(nodes[0], 1);
6910 }
6911
6912 #[test]
6913 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6914         //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.
6915
6916         let chanmon_cfgs = create_chanmon_cfgs(2);
6917         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6918         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6919         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6920         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6921         let logger = test_utils::TestLogger::new();
6922
6923         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6924         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6925         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6926         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6927         check_added_monitors!(nodes[0], 1);
6928         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6929         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6930
6931         let update_msg = msgs::UpdateFailHTLC{
6932                 channel_id: chan.2,
6933                 htlc_id: 0,
6934                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6935         };
6936
6937         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6938
6939         assert!(nodes[0].node.list_channels().is_empty());
6940         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6941         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()));
6942         check_added_monitors!(nodes[0], 1);
6943 }
6944
6945 #[test]
6946 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6947         //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.
6948
6949         let chanmon_cfgs = create_chanmon_cfgs(2);
6950         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6951         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6952         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6953         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6954         let logger = test_utils::TestLogger::new();
6955
6956         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6957         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6958         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6959         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6960         check_added_monitors!(nodes[0], 1);
6961         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6962         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6963         let update_msg = msgs::UpdateFailMalformedHTLC{
6964                 channel_id: chan.2,
6965                 htlc_id: 0,
6966                 sha256_of_onion: [1; 32],
6967                 failure_code: 0x8000,
6968         };
6969
6970         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6971
6972         assert!(nodes[0].node.list_channels().is_empty());
6973         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6974         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()));
6975         check_added_monitors!(nodes[0], 1);
6976 }
6977
6978 #[test]
6979 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6980         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6981
6982         let chanmon_cfgs = create_chanmon_cfgs(2);
6983         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6984         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6985         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6986         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6987
6988         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6989
6990         nodes[1].node.claim_funds(our_payment_preimage);
6991         check_added_monitors!(nodes[1], 1);
6992
6993         let events = nodes[1].node.get_and_clear_pending_msg_events();
6994         assert_eq!(events.len(), 1);
6995         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6996                 match events[0] {
6997                         MessageSendEvent::UpdateHTLCs { node_id: _ , updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, .. } } => {
6998                                 assert!(update_add_htlcs.is_empty());
6999                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7000                                 assert!(update_fail_htlcs.is_empty());
7001                                 assert!(update_fail_malformed_htlcs.is_empty());
7002                                 assert!(update_fee.is_none());
7003                                 update_fulfill_htlcs[0].clone()
7004                         },
7005                         _ => panic!("Unexpected event"),
7006                 }
7007         };
7008
7009         update_fulfill_msg.htlc_id = 1;
7010
7011         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7012
7013         assert!(nodes[0].node.list_channels().is_empty());
7014         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7015         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
7016         check_added_monitors!(nodes[0], 1);
7017 }
7018
7019 #[test]
7020 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
7021         //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.
7022
7023         let chanmon_cfgs = create_chanmon_cfgs(2);
7024         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7025         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7026         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7027         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7028
7029         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7030
7031         nodes[1].node.claim_funds(our_payment_preimage);
7032         check_added_monitors!(nodes[1], 1);
7033
7034         let events = nodes[1].node.get_and_clear_pending_msg_events();
7035         assert_eq!(events.len(), 1);
7036         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7037                 match events[0] {
7038                         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, .. } } => {
7039                                 assert!(update_add_htlcs.is_empty());
7040                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7041                                 assert!(update_fail_htlcs.is_empty());
7042                                 assert!(update_fail_malformed_htlcs.is_empty());
7043                                 assert!(update_fee.is_none());
7044                                 update_fulfill_htlcs[0].clone()
7045                         },
7046                         _ => panic!("Unexpected event"),
7047                 }
7048         };
7049
7050         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
7051
7052         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7053
7054         assert!(nodes[0].node.list_channels().is_empty());
7055         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7056         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
7057         check_added_monitors!(nodes[0], 1);
7058 }
7059
7060 #[test]
7061 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
7062         //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.
7063
7064         let chanmon_cfgs = create_chanmon_cfgs(2);
7065         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7066         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7067         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7068         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7069         let logger = test_utils::TestLogger::new();
7070
7071         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7072         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7073         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
7074         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7075         check_added_monitors!(nodes[0], 1);
7076
7077         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7078         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7079
7080         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7081         check_added_monitors!(nodes[1], 0);
7082         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7083
7084         let events = nodes[1].node.get_and_clear_pending_msg_events();
7085
7086         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7087                 match events[0] {
7088                         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, .. } } => {
7089                                 assert!(update_add_htlcs.is_empty());
7090                                 assert!(update_fulfill_htlcs.is_empty());
7091                                 assert!(update_fail_htlcs.is_empty());
7092                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7093                                 assert!(update_fee.is_none());
7094                                 update_fail_malformed_htlcs[0].clone()
7095                         },
7096                         _ => panic!("Unexpected event"),
7097                 }
7098         };
7099         update_msg.failure_code &= !0x8000;
7100         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7101
7102         assert!(nodes[0].node.list_channels().is_empty());
7103         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7104         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7105         check_added_monitors!(nodes[0], 1);
7106 }
7107
7108 #[test]
7109 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7110         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7111         //    * 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.
7112
7113         let chanmon_cfgs = create_chanmon_cfgs(3);
7114         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7115         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7116         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7117         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7118         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7119         let logger = test_utils::TestLogger::new();
7120
7121         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7122
7123         //First hop
7124         let mut payment_event = {
7125                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7126                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
7127                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7128                 check_added_monitors!(nodes[0], 1);
7129                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7130                 assert_eq!(events.len(), 1);
7131                 SendEvent::from_event(events.remove(0))
7132         };
7133         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7134         check_added_monitors!(nodes[1], 0);
7135         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7136         expect_pending_htlcs_forwardable!(nodes[1]);
7137         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7138         assert_eq!(events_2.len(), 1);
7139         check_added_monitors!(nodes[1], 1);
7140         payment_event = SendEvent::from_event(events_2.remove(0));
7141         assert_eq!(payment_event.msgs.len(), 1);
7142
7143         //Second Hop
7144         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7145         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7146         check_added_monitors!(nodes[2], 0);
7147         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7148
7149         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7150         assert_eq!(events_3.len(), 1);
7151         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7152                 match events_3[0] {
7153                         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 } } => {
7154                                 assert!(update_add_htlcs.is_empty());
7155                                 assert!(update_fulfill_htlcs.is_empty());
7156                                 assert!(update_fail_htlcs.is_empty());
7157                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7158                                 assert!(update_fee.is_none());
7159                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7160                         },
7161                         _ => panic!("Unexpected event"),
7162                 }
7163         };
7164
7165         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7166
7167         check_added_monitors!(nodes[1], 0);
7168         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7169         expect_pending_htlcs_forwardable!(nodes[1]);
7170         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7171         assert_eq!(events_4.len(), 1);
7172
7173         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7174         match events_4[0] {
7175                 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, .. } } => {
7176                         assert!(update_add_htlcs.is_empty());
7177                         assert!(update_fulfill_htlcs.is_empty());
7178                         assert_eq!(update_fail_htlcs.len(), 1);
7179                         assert!(update_fail_malformed_htlcs.is_empty());
7180                         assert!(update_fee.is_none());
7181                 },
7182                 _ => panic!("Unexpected event"),
7183         };
7184
7185         check_added_monitors!(nodes[1], 1);
7186 }
7187
7188 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7189         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7190         // 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
7191         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7192
7193         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7194         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7195         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7196         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7197         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7198         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7199
7200         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7201
7202         // We route 2 dust-HTLCs between A and B
7203         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7204         let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7205         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7206
7207         // Cache one local commitment tx as previous
7208         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7209
7210         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7211         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7212         check_added_monitors!(nodes[1], 0);
7213         expect_pending_htlcs_forwardable!(nodes[1]);
7214         check_added_monitors!(nodes[1], 1);
7215
7216         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7217         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7218         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7219         check_added_monitors!(nodes[0], 1);
7220
7221         // Cache one local commitment tx as lastest
7222         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7223
7224         let events = nodes[0].node.get_and_clear_pending_msg_events();
7225         match events[0] {
7226                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7227                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7228                 },
7229                 _ => panic!("Unexpected event"),
7230         }
7231         match events[1] {
7232                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7233                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7234                 },
7235                 _ => panic!("Unexpected event"),
7236         }
7237
7238         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7239         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7240         if announce_latest {
7241                 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7242         } else {
7243                 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7244         }
7245
7246         check_closed_broadcast!(nodes[0], true);
7247         check_added_monitors!(nodes[0], 1);
7248
7249         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7250         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7251         let events = nodes[0].node.get_and_clear_pending_events();
7252         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7253         assert_eq!(events.len(), 2);
7254         let mut first_failed = false;
7255         for event in events {
7256                 match event {
7257                         Event::PaymentFailed { payment_hash, .. } => {
7258                                 if payment_hash == payment_hash_1 {
7259                                         assert!(!first_failed);
7260                                         first_failed = true;
7261                                 } else {
7262                                         assert_eq!(payment_hash, payment_hash_2);
7263                                 }
7264                         }
7265                         _ => panic!("Unexpected event"),
7266                 }
7267         }
7268 }
7269
7270 #[test]
7271 fn test_failure_delay_dust_htlc_local_commitment() {
7272         do_test_failure_delay_dust_htlc_local_commitment(true);
7273         do_test_failure_delay_dust_htlc_local_commitment(false);
7274 }
7275
7276 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7277         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7278         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7279         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7280         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7281         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7282         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7283
7284         let chanmon_cfgs = create_chanmon_cfgs(3);
7285         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7286         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7287         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7288         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7289
7290         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7291
7292         let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7293         let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7294
7295         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7296         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7297
7298         // We revoked bs_commitment_tx
7299         if revoked {
7300                 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7301                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7302         }
7303
7304         let mut timeout_tx = Vec::new();
7305         if local {
7306                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7307                 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7308                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7309                 expect_payment_failed!(nodes[0], dust_hash, true);
7310
7311                 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
7312                 check_closed_broadcast!(nodes[0], true);
7313                 check_added_monitors!(nodes[0], 1);
7314                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7315                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7316                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7317                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7318                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7319                 mine_transaction(&nodes[0], &timeout_tx[0]);
7320                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7321                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7322         } else {
7323                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7324                 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7325                 check_closed_broadcast!(nodes[0], true);
7326                 check_added_monitors!(nodes[0], 1);
7327                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7328                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7329                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7330                 if !revoked {
7331                         expect_payment_failed!(nodes[0], dust_hash, true);
7332                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7333                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7334                         mine_transaction(&nodes[0], &timeout_tx[0]);
7335                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7336                         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7337                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7338                 } else {
7339                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7340                         // commitment tx
7341                         let events = nodes[0].node.get_and_clear_pending_events();
7342                         assert_eq!(events.len(), 2);
7343                         let first;
7344                         match events[0] {
7345                                 Event::PaymentFailed { payment_hash, .. } => {
7346                                         if payment_hash == dust_hash { first = true; }
7347                                         else { first = false; }
7348                                 },
7349                                 _ => panic!("Unexpected event"),
7350                         }
7351                         match events[1] {
7352                                 Event::PaymentFailed { payment_hash, .. } => {
7353                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7354                                         else { assert_eq!(payment_hash, dust_hash); }
7355                                 },
7356                                 _ => panic!("Unexpected event"),
7357                         }
7358                 }
7359         }
7360 }
7361
7362 #[test]
7363 fn test_sweep_outbound_htlc_failure_update() {
7364         do_test_sweep_outbound_htlc_failure_update(false, true);
7365         do_test_sweep_outbound_htlc_failure_update(false, false);
7366         do_test_sweep_outbound_htlc_failure_update(true, false);
7367 }
7368
7369 #[test]
7370 fn test_upfront_shutdown_script() {
7371         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7372         // enforce it at shutdown message
7373
7374         let mut config = UserConfig::default();
7375         config.channel_options.announced_channel = true;
7376         config.peer_channel_config_limits.force_announced_channel_preference = false;
7377         config.channel_options.commit_upfront_shutdown_pubkey = false;
7378         let user_cfgs = [None, Some(config), None];
7379         let chanmon_cfgs = create_chanmon_cfgs(3);
7380         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7381         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7382         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7383
7384         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7385         let flags = InitFeatures::known();
7386         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7387         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7388         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7389         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7390         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7391         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7392     assert!(regex::Regex::new(r"Got shutdown request with a scriptpubkey \([A-Fa-f0-9]+\) which did not match their previous scriptpubkey.").unwrap().is_match(check_closed_broadcast!(nodes[2], true).unwrap().data.as_str()));
7393         check_added_monitors!(nodes[2], 1);
7394
7395         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7396         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7397         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7398         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7399         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7400         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7401         let events = nodes[2].node.get_and_clear_pending_msg_events();
7402         assert_eq!(events.len(), 1);
7403         match events[0] {
7404                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7405                 _ => panic!("Unexpected event"),
7406         }
7407
7408         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7409         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7410         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7411         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7412         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7413         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7414         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7415         let events = nodes[1].node.get_and_clear_pending_msg_events();
7416         assert_eq!(events.len(), 1);
7417         match events[0] {
7418                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7419                 _ => panic!("Unexpected event"),
7420         }
7421
7422         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7423         // channel smoothly, opt-out is from channel initiator here
7424         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7425         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7426         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7427         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7428         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7429         let events = nodes[0].node.get_and_clear_pending_msg_events();
7430         assert_eq!(events.len(), 1);
7431         match events[0] {
7432                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7433                 _ => panic!("Unexpected event"),
7434         }
7435
7436         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7437         //// channel smoothly
7438         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7439         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7440         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7441         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7442         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7443         let events = nodes[0].node.get_and_clear_pending_msg_events();
7444         assert_eq!(events.len(), 2);
7445         match events[0] {
7446                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7447                 _ => panic!("Unexpected event"),
7448         }
7449         match events[1] {
7450                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7451                 _ => panic!("Unexpected event"),
7452         }
7453 }
7454
7455 #[test]
7456 fn test_upfront_shutdown_script_unsupport_segwit() {
7457         // We test that channel is closed early
7458         // if a segwit program is passed as upfront shutdown script,
7459         // but the peer does not support segwit.
7460         let chanmon_cfgs = create_chanmon_cfgs(2);
7461         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7462         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7463         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7464
7465         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7466
7467         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7468         open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(16)
7469                 .push_slice(&[0, 0])
7470                 .into_script());
7471
7472         let features = InitFeatures::known().clear_shutdown_anysegwit();
7473         nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), features, &open_channel);
7474
7475         let events = nodes[0].node.get_and_clear_pending_msg_events();
7476         assert_eq!(events.len(), 1);
7477         match events[0] {
7478                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7479                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
7480                         assert!(regex::Regex::new(r"Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format. script: (\([A-Fa-f0-9]+\))").unwrap().is_match(&*msg.data));
7481                 },
7482                 _ => panic!("Unexpected event"),
7483         }
7484 }
7485
7486 #[test]
7487 fn test_shutdown_script_any_segwit_allowed() {
7488         let mut config = UserConfig::default();
7489         config.channel_options.announced_channel = true;
7490         config.peer_channel_config_limits.force_announced_channel_preference = false;
7491         config.channel_options.commit_upfront_shutdown_pubkey = false;
7492         let user_cfgs = [None, Some(config), None];
7493         let chanmon_cfgs = create_chanmon_cfgs(3);
7494         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7495         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7496         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7497
7498         //// We test if the remote peer accepts opt_shutdown_anysegwit, a witness program can be used on shutdown
7499         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7500         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7501         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7502         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7503                 .push_slice(&[0, 0])
7504                 .into_script();
7505         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7506         let events = nodes[0].node.get_and_clear_pending_msg_events();
7507         assert_eq!(events.len(), 2);
7508         match events[0] {
7509                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7510                 _ => panic!("Unexpected event"),
7511         }
7512         match events[1] {
7513                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7514                 _ => panic!("Unexpected event"),
7515         }
7516 }
7517
7518 #[test]
7519 fn test_shutdown_script_any_segwit_not_allowed() {
7520         let mut config = UserConfig::default();
7521         config.channel_options.announced_channel = true;
7522         config.peer_channel_config_limits.force_announced_channel_preference = false;
7523         config.channel_options.commit_upfront_shutdown_pubkey = false;
7524         let user_cfgs = [None, Some(config), None];
7525         let chanmon_cfgs = create_chanmon_cfgs(3);
7526         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7527         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7528         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7529
7530         //// We test that if the remote peer does not accept opt_shutdown_anysegwit, the witness program cannot be used on shutdown
7531         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7532         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7533         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7534         // Make an any segwit version script
7535         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7536                 .push_slice(&[0, 0])
7537                 .into_script();
7538         let flags_no = InitFeatures::known().clear_shutdown_anysegwit();
7539         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &flags_no, &node_0_shutdown);
7540         let events = nodes[0].node.get_and_clear_pending_msg_events();
7541         assert_eq!(events.len(), 2);
7542         match events[1] {
7543                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7544                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7545                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020000) from remote peer".to_owned())
7546                 },
7547                 _ => panic!("Unexpected event"),
7548         }
7549         check_added_monitors!(nodes[0], 1);
7550 }
7551
7552 #[test]
7553 fn test_shutdown_script_segwit_but_not_anysegwit() {
7554         let mut config = UserConfig::default();
7555         config.channel_options.announced_channel = true;
7556         config.peer_channel_config_limits.force_announced_channel_preference = false;
7557         config.channel_options.commit_upfront_shutdown_pubkey = false;
7558         let user_cfgs = [None, Some(config), None];
7559         let chanmon_cfgs = create_chanmon_cfgs(3);
7560         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7561         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7562         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7563
7564         //// We test that if shutdown any segwit is supported and we send a witness script with 0 version, this is not accepted
7565         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7566         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7567         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7568         // Make a segwit script that is not a valid as any segwit
7569         node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7570                 .push_slice(&[0, 0])
7571                 .into_script();
7572         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7573         let events = nodes[0].node.get_and_clear_pending_msg_events();
7574         assert_eq!(events.len(), 2);
7575         match events[1] {
7576                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7577                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7578                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7579                 },
7580                 _ => panic!("Unexpected event"),
7581         }
7582         check_added_monitors!(nodes[0], 1);
7583 }
7584
7585 #[test]
7586 fn test_user_configurable_csv_delay() {
7587         // We test our channel constructors yield errors when we pass them absurd csv delay
7588
7589         let mut low_our_to_self_config = UserConfig::default();
7590         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7591         let mut high_their_to_self_config = UserConfig::default();
7592         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7593         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7594         let chanmon_cfgs = create_chanmon_cfgs(2);
7595         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7596         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7597         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7598
7599         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7600         if let Err(error) = Channel::new_outbound(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), 1000000, 1000000, 0, &low_our_to_self_config) {
7601                 match error {
7602                         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())); },
7603                         _ => panic!("Unexpected event"),
7604                 }
7605         } else { assert!(false) }
7606
7607         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7608         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7609         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7610         open_channel.to_self_delay = 200;
7611         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &low_our_to_self_config) {
7612                 match error {
7613                         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()));  },
7614                         _ => panic!("Unexpected event"),
7615                 }
7616         } else { assert!(false); }
7617
7618         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7619         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7620         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()));
7621         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7622         accept_channel.to_self_delay = 200;
7623         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7624         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7625                 match action {
7626                         &ErrorAction::SendErrorMessage { ref msg } => {
7627                                 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()));
7628                         },
7629                         _ => { assert!(false); }
7630                 }
7631         } else { assert!(false); }
7632
7633         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7634         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7635         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7636         open_channel.to_self_delay = 200;
7637         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &high_their_to_self_config) {
7638                 match error {
7639                         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())); },
7640                         _ => panic!("Unexpected event"),
7641                 }
7642         } else { assert!(false); }
7643 }
7644
7645 #[test]
7646 fn test_data_loss_protect() {
7647         // We want to be sure that :
7648         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7649         //   (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7650         // * we close channel in case of detecting other being fallen behind
7651         // * we are able to claim our own outputs thanks to to_remote being static
7652         // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7653         let persister;
7654         let logger;
7655         let fee_estimator;
7656         let tx_broadcaster;
7657         let chain_source;
7658         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7659         // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7660         // during signing due to revoked tx
7661         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7662         let keys_manager = &chanmon_cfgs[0].keys_manager;
7663         let monitor;
7664         let node_state_0;
7665         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7666         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7667         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7668
7669         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7670
7671         // Cache node A state before any channel update
7672         let previous_node_state = nodes[0].node.encode();
7673         let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7674         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7675
7676         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7677         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7678
7679         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7680         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7681
7682         // Restore node A from previous state
7683         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7684         let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7685         chain_source = test_utils::TestChainSource::new(Network::Testnet);
7686         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7687         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7688         persister = test_utils::TestPersister::new();
7689         monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7690         node_state_0 = {
7691                 let mut channel_monitors = HashMap::new();
7692                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7693                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
7694                         keys_manager: keys_manager,
7695                         fee_estimator: &fee_estimator,
7696                         chain_monitor: &monitor,
7697                         logger: &logger,
7698                         tx_broadcaster: &tx_broadcaster,
7699                         default_config: UserConfig::default(),
7700                         channel_monitors,
7701                 }).unwrap().1
7702         };
7703         nodes[0].node = &node_state_0;
7704         assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7705         nodes[0].chain_monitor = &monitor;
7706         nodes[0].chain_source = &chain_source;
7707
7708         check_added_monitors!(nodes[0], 1);
7709
7710         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7711         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7712
7713         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7714
7715         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7716         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7717         check_added_monitors!(nodes[0], 1);
7718
7719         {
7720                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7721                 assert_eq!(node_txn.len(), 0);
7722         }
7723
7724         let mut reestablish_1 = Vec::with_capacity(1);
7725         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7726                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7727                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7728                         reestablish_1.push(msg.clone());
7729                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7730                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7731                         match action {
7732                                 &ErrorAction::SendErrorMessage { ref msg } => {
7733                                         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");
7734                                 },
7735                                 _ => panic!("Unexpected event!"),
7736                         }
7737                 } else {
7738                         panic!("Unexpected event")
7739                 }
7740         }
7741
7742         // Check we close channel detecting A is fallen-behind
7743         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7744         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7745         check_added_monitors!(nodes[1], 1);
7746
7747
7748         // Check A is able to claim to_remote output
7749         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7750         assert_eq!(node_txn.len(), 1);
7751         check_spends!(node_txn[0], chan.3);
7752         assert_eq!(node_txn[0].output.len(), 2);
7753         mine_transaction(&nodes[0], &node_txn[0]);
7754         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7755         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
7756         assert_eq!(spend_txn.len(), 1);
7757         check_spends!(spend_txn[0], node_txn[0]);
7758 }
7759
7760 #[test]
7761 fn test_check_htlc_underpaying() {
7762         // Send payment through A -> B but A is maliciously
7763         // sending a probe payment (i.e less than expected value0
7764         // to B, B should refuse payment.
7765
7766         let chanmon_cfgs = create_chanmon_cfgs(2);
7767         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7768         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7769         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7770
7771         // Create some initial channels
7772         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7773
7774         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
7775         let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7776         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7777         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7778         check_added_monitors!(nodes[0], 1);
7779
7780         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7781         assert_eq!(events.len(), 1);
7782         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7783         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7784         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7785
7786         // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7787         // and then will wait a second random delay before failing the HTLC back:
7788         expect_pending_htlcs_forwardable!(nodes[1]);
7789         expect_pending_htlcs_forwardable!(nodes[1]);
7790
7791         // Node 3 is expecting payment of 100_000 but received 10_000,
7792         // it should fail htlc like we didn't know the preimage.
7793         nodes[1].node.process_pending_htlc_forwards();
7794
7795         let events = nodes[1].node.get_and_clear_pending_msg_events();
7796         assert_eq!(events.len(), 1);
7797         let (update_fail_htlc, commitment_signed) = match events[0] {
7798                 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 } } => {
7799                         assert!(update_add_htlcs.is_empty());
7800                         assert!(update_fulfill_htlcs.is_empty());
7801                         assert_eq!(update_fail_htlcs.len(), 1);
7802                         assert!(update_fail_malformed_htlcs.is_empty());
7803                         assert!(update_fee.is_none());
7804                         (update_fail_htlcs[0].clone(), commitment_signed)
7805                 },
7806                 _ => panic!("Unexpected event"),
7807         };
7808         check_added_monitors!(nodes[1], 1);
7809
7810         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7811         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7812
7813         // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7814         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7815         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7816         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7817 }
7818
7819 #[test]
7820 fn test_announce_disable_channels() {
7821         // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7822         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7823
7824         let chanmon_cfgs = create_chanmon_cfgs(2);
7825         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7826         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7827         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7828
7829         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7830         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7831         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7832
7833         // Disconnect peers
7834         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7835         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7836
7837         nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7838         nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7839         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7840         assert_eq!(msg_events.len(), 3);
7841         let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7842         for e in msg_events {
7843                 match e {
7844                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7845                                 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7846                                 // Check that each channel gets updated exactly once
7847                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7848                                         panic!("Generated ChannelUpdate for wrong chan!");
7849                                 }
7850                         },
7851                         _ => panic!("Unexpected event"),
7852                 }
7853         }
7854         // Reconnect peers
7855         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7856         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7857         assert_eq!(reestablish_1.len(), 3);
7858         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7859         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7860         assert_eq!(reestablish_2.len(), 3);
7861
7862         // Reestablish chan_1
7863         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7864         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7865         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7866         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7867         // Reestablish chan_2
7868         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7869         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7870         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7871         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7872         // Reestablish chan_3
7873         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7874         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7875         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7876         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7877
7878         nodes[0].node.timer_tick_occurred();
7879         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7880         nodes[0].node.timer_tick_occurred();
7881         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7882         assert_eq!(msg_events.len(), 3);
7883         chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7884         for e in msg_events {
7885                 match e {
7886                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7887                                 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7888                                 // Check that each channel gets updated exactly once
7889                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7890                                         panic!("Generated ChannelUpdate for wrong chan!");
7891                                 }
7892                         },
7893                         _ => panic!("Unexpected event"),
7894                 }
7895         }
7896 }
7897
7898 #[test]
7899 fn test_bump_penalty_txn_on_revoked_commitment() {
7900         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7901         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7902
7903         let chanmon_cfgs = create_chanmon_cfgs(2);
7904         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7905         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7906         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7907
7908         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7909         let logger = test_utils::TestLogger::new();
7910
7911         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7912         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7913         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3000000, 30, &logger).unwrap();
7914         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7915
7916         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7917         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7918         assert_eq!(revoked_txn[0].output.len(), 4);
7919         assert_eq!(revoked_txn[0].input.len(), 1);
7920         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7921         let revoked_txid = revoked_txn[0].txid();
7922
7923         let mut penalty_sum = 0;
7924         for outp in revoked_txn[0].output.iter() {
7925                 if outp.script_pubkey.is_v0_p2wsh() {
7926                         penalty_sum += outp.value;
7927                 }
7928         }
7929
7930         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7931         let header_114 = connect_blocks(&nodes[1], 14);
7932
7933         // Actually revoke tx by claiming a HTLC
7934         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7935         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7936         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7937         check_added_monitors!(nodes[1], 1);
7938
7939         // One or more justice tx should have been broadcast, check it
7940         let penalty_1;
7941         let feerate_1;
7942         {
7943                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7944                 assert_eq!(node_txn.len(), 2); // justice tx (broadcasted from ChannelMonitor) + local commitment tx
7945                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7946                 assert_eq!(node_txn[0].output.len(), 1);
7947                 check_spends!(node_txn[0], revoked_txn[0]);
7948                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7949                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7950                 penalty_1 = node_txn[0].txid();
7951                 node_txn.clear();
7952         };
7953
7954         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7955         connect_blocks(&nodes[1], 15);
7956         let mut penalty_2 = penalty_1;
7957         let mut feerate_2 = 0;
7958         {
7959                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7960                 assert_eq!(node_txn.len(), 1);
7961                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7962                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7963                         assert_eq!(node_txn[0].output.len(), 1);
7964                         check_spends!(node_txn[0], revoked_txn[0]);
7965                         penalty_2 = node_txn[0].txid();
7966                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7967                         assert_ne!(penalty_2, penalty_1);
7968                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7969                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7970                         // Verify 25% bump heuristic
7971                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7972                         node_txn.clear();
7973                 }
7974         }
7975         assert_ne!(feerate_2, 0);
7976
7977         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7978         connect_blocks(&nodes[1], 1);
7979         let penalty_3;
7980         let mut feerate_3 = 0;
7981         {
7982                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7983                 assert_eq!(node_txn.len(), 1);
7984                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7985                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7986                         assert_eq!(node_txn[0].output.len(), 1);
7987                         check_spends!(node_txn[0], revoked_txn[0]);
7988                         penalty_3 = node_txn[0].txid();
7989                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7990                         assert_ne!(penalty_3, penalty_2);
7991                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7992                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7993                         // Verify 25% bump heuristic
7994                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7995                         node_txn.clear();
7996                 }
7997         }
7998         assert_ne!(feerate_3, 0);
7999
8000         nodes[1].node.get_and_clear_pending_events();
8001         nodes[1].node.get_and_clear_pending_msg_events();
8002 }
8003
8004 #[test]
8005 fn test_bump_penalty_txn_on_revoked_htlcs() {
8006         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
8007         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
8008
8009         let mut chanmon_cfgs = create_chanmon_cfgs(2);
8010         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
8011         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8012         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8013         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8014
8015         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8016         // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
8017         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
8018                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8019         let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
8020         let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph.read().unwrap(),
8021                 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8022         send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
8023
8024         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8025         assert_eq!(revoked_local_txn[0].input.len(), 1);
8026         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8027
8028         // Revoke local commitment tx
8029         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8030
8031         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8032         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
8033         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
8034         check_closed_broadcast!(nodes[1], true);
8035         check_added_monitors!(nodes[1], 1);
8036         connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
8037
8038         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8039         assert_eq!(revoked_htlc_txn.len(), 3);
8040         check_spends!(revoked_htlc_txn[1], chan.3);
8041
8042         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
8043         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8044         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8045
8046         assert_eq!(revoked_htlc_txn[2].input.len(), 1);
8047         assert_eq!(revoked_htlc_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8048         assert_eq!(revoked_htlc_txn[2].output.len(), 1);
8049         check_spends!(revoked_htlc_txn[2], revoked_local_txn[0]);
8050
8051         // Broadcast set of revoked txn on A
8052         let hash_128 = connect_blocks(&nodes[0], 40);
8053         let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8054         connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
8055         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8056         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[2].clone()] });
8057         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8058         let first;
8059         let feerate_1;
8060         let penalty_txn;
8061         {
8062                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8063                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
8064                 // Verify claim tx are spending revoked HTLC txn
8065
8066                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
8067                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
8068                 // which are included in the same block (they are broadcasted because we scan the
8069                 // transactions linearly and generate claims as we go, they likely should be removed in the
8070                 // future).
8071                 assert_eq!(node_txn[0].input.len(), 1);
8072                 check_spends!(node_txn[0], revoked_local_txn[0]);
8073                 assert_eq!(node_txn[1].input.len(), 1);
8074                 check_spends!(node_txn[1], revoked_local_txn[0]);
8075                 assert_eq!(node_txn[2].input.len(), 1);
8076                 check_spends!(node_txn[2], revoked_local_txn[0]);
8077
8078                 // Each of the three justice transactions claim a separate (single) output of the three
8079                 // available, which we check here:
8080                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
8081                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
8082                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
8083
8084                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8085                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8086
8087                 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
8088                 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
8089                 // a remote commitment tx has already been confirmed).
8090                 check_spends!(node_txn[3], chan.3);
8091
8092                 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
8093                 // output, checked above).
8094                 assert_eq!(node_txn[4].input.len(), 2);
8095                 assert_eq!(node_txn[4].output.len(), 1);
8096                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8097
8098                 first = node_txn[4].txid();
8099                 // Store both feerates for later comparison
8100                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[4].output[0].value;
8101                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
8102                 penalty_txn = vec![node_txn[2].clone()];
8103                 node_txn.clear();
8104         }
8105
8106         // Connect one more block to see if bumped penalty are issued for HTLC txn
8107         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8108         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8109         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8110         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
8111         {
8112                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8113                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
8114
8115                 check_spends!(node_txn[0], revoked_local_txn[0]);
8116                 check_spends!(node_txn[1], revoked_local_txn[0]);
8117                 // Note that these are both bogus - they spend outputs already claimed in block 129:
8118                 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output  {
8119                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8120                 } else {
8121                         assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8122                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8123                 }
8124
8125                 node_txn.clear();
8126         };
8127
8128         // Few more blocks to confirm penalty txn
8129         connect_blocks(&nodes[0], 4);
8130         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8131         let header_144 = connect_blocks(&nodes[0], 9);
8132         let node_txn = {
8133                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8134                 assert_eq!(node_txn.len(), 1);
8135
8136                 assert_eq!(node_txn[0].input.len(), 2);
8137                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8138                 // Verify bumped tx is different and 25% bump heuristic
8139                 assert_ne!(first, node_txn[0].txid());
8140                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[0].output[0].value;
8141                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8142                 assert!(feerate_2 * 100 > feerate_1 * 125);
8143                 let txn = vec![node_txn[0].clone()];
8144                 node_txn.clear();
8145                 txn
8146         };
8147         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8148         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8149         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
8150         connect_blocks(&nodes[0], 20);
8151         {
8152                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8153                 // We verify than no new transaction has been broadcast because previously
8154                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8155                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8156                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8157                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8158                 // up bumped justice generation.
8159                 assert_eq!(node_txn.len(), 0);
8160                 node_txn.clear();
8161         }
8162         check_closed_broadcast!(nodes[0], true);
8163         check_added_monitors!(nodes[0], 1);
8164 }
8165
8166 #[test]
8167 fn test_bump_penalty_txn_on_remote_commitment() {
8168         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8169         // we're able to claim outputs on remote commitment transaction before timelocks expiration
8170
8171         // Create 2 HTLCs
8172         // Provide preimage for one
8173         // Check aggregation
8174
8175         let chanmon_cfgs = create_chanmon_cfgs(2);
8176         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8177         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8178         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8179
8180         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8181         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8182         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8183
8184         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8185         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8186         assert_eq!(remote_txn[0].output.len(), 4);
8187         assert_eq!(remote_txn[0].input.len(), 1);
8188         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8189
8190         // Claim a HTLC without revocation (provide B monitor with preimage)
8191         nodes[1].node.claim_funds(payment_preimage);
8192         mine_transaction(&nodes[1], &remote_txn[0]);
8193         check_added_monitors!(nodes[1], 2);
8194         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
8195
8196         // One or more claim tx should have been broadcast, check it
8197         let timeout;
8198         let preimage;
8199         let preimage_bump;
8200         let feerate_timeout;
8201         let feerate_preimage;
8202         {
8203                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8204                 // 9 transactions including:
8205                 // 1*2 ChannelManager local broadcasts of commitment + HTLC-Success
8206                 // 1*3 ChannelManager local broadcasts of commitment + HTLC-Success + HTLC-Timeout
8207                 // 2 * HTLC-Success (one RBF bump we'll check later)
8208                 // 1 * HTLC-Timeout
8209                 assert_eq!(node_txn.len(), 8);
8210                 assert_eq!(node_txn[0].input.len(), 1);
8211                 assert_eq!(node_txn[6].input.len(), 1);
8212                 check_spends!(node_txn[0], remote_txn[0]);
8213                 check_spends!(node_txn[6], remote_txn[0]);
8214                 assert_eq!(node_txn[0].input[0].previous_output, node_txn[3].input[0].previous_output);
8215                 preimage_bump = node_txn[3].clone();
8216
8217                 check_spends!(node_txn[1], chan.3);
8218                 check_spends!(node_txn[2], node_txn[1]);
8219                 assert_eq!(node_txn[1], node_txn[4]);
8220                 assert_eq!(node_txn[2], node_txn[5]);
8221
8222                 timeout = node_txn[6].txid();
8223                 let index = node_txn[6].input[0].previous_output.vout;
8224                 let fee = remote_txn[0].output[index as usize].value - node_txn[6].output[0].value;
8225                 feerate_timeout = fee * 1000 / node_txn[6].get_weight() as u64;
8226
8227                 preimage = node_txn[0].txid();
8228                 let index = node_txn[0].input[0].previous_output.vout;
8229                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8230                 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8231
8232                 node_txn.clear();
8233         };
8234         assert_ne!(feerate_timeout, 0);
8235         assert_ne!(feerate_preimage, 0);
8236
8237         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8238         connect_blocks(&nodes[1], 15);
8239         {
8240                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8241                 assert_eq!(node_txn.len(), 1);
8242                 assert_eq!(node_txn[0].input.len(), 1);
8243                 assert_eq!(preimage_bump.input.len(), 1);
8244                 check_spends!(node_txn[0], remote_txn[0]);
8245                 check_spends!(preimage_bump, remote_txn[0]);
8246
8247                 let index = preimage_bump.input[0].previous_output.vout;
8248                 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
8249                 let new_feerate = fee * 1000 / preimage_bump.get_weight() as u64;
8250                 assert!(new_feerate * 100 > feerate_timeout * 125);
8251                 assert_ne!(timeout, preimage_bump.txid());
8252
8253                 let index = node_txn[0].input[0].previous_output.vout;
8254                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8255                 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8256                 assert!(new_feerate * 100 > feerate_preimage * 125);
8257                 assert_ne!(preimage, node_txn[0].txid());
8258
8259                 node_txn.clear();
8260         }
8261
8262         nodes[1].node.get_and_clear_pending_events();
8263         nodes[1].node.get_and_clear_pending_msg_events();
8264 }
8265
8266 #[test]
8267 fn test_counterparty_raa_skip_no_crash() {
8268         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8269         // commitment transaction, we would have happily carried on and provided them the next
8270         // commitment transaction based on one RAA forward. This would probably eventually have led to
8271         // channel closure, but it would not have resulted in funds loss. Still, our
8272         // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
8273         // check simply that the channel is closed in response to such an RAA, but don't check whether
8274         // we decide to punish our counterparty for revoking their funds (as we don't currently
8275         // implement that).
8276         let chanmon_cfgs = create_chanmon_cfgs(2);
8277         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8278         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8279         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8280         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8281
8282         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8283         let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8284         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8285         let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8286         // Must revoke without gaps
8287         keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8288         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8289                 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8290
8291         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8292                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8293         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8294         check_added_monitors!(nodes[1], 1);
8295 }
8296
8297 #[test]
8298 fn test_bump_txn_sanitize_tracking_maps() {
8299         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8300         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8301
8302         let chanmon_cfgs = create_chanmon_cfgs(2);
8303         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8304         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8305         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8306
8307         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8308         // Lock HTLC in both directions
8309         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8310         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8311
8312         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8313         assert_eq!(revoked_local_txn[0].input.len(), 1);
8314         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8315
8316         // Revoke local commitment tx
8317         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8318
8319         // Broadcast set of revoked txn on A
8320         connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8321         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8322         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8323
8324         mine_transaction(&nodes[0], &revoked_local_txn[0]);
8325         check_closed_broadcast!(nodes[0], true);
8326         check_added_monitors!(nodes[0], 1);
8327         let penalty_txn = {
8328                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8329                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8330                 check_spends!(node_txn[0], revoked_local_txn[0]);
8331                 check_spends!(node_txn[1], revoked_local_txn[0]);
8332                 check_spends!(node_txn[2], revoked_local_txn[0]);
8333                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8334                 node_txn.clear();
8335                 penalty_txn
8336         };
8337         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8338         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8339         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8340         {
8341                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8342                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8343                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8344                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8345                 }
8346         }
8347 }
8348
8349 #[test]
8350 fn test_override_channel_config() {
8351         let chanmon_cfgs = create_chanmon_cfgs(2);
8352         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8353         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8354         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8355
8356         // Node0 initiates a channel to node1 using the override config.
8357         let mut override_config = UserConfig::default();
8358         override_config.own_channel_config.our_to_self_delay = 200;
8359
8360         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8361
8362         // Assert the channel created by node0 is using the override config.
8363         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8364         assert_eq!(res.channel_flags, 0);
8365         assert_eq!(res.to_self_delay, 200);
8366 }
8367
8368 #[test]
8369 fn test_override_0msat_htlc_minimum() {
8370         let mut zero_config = UserConfig::default();
8371         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8372         let chanmon_cfgs = create_chanmon_cfgs(2);
8373         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8374         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8375         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8376
8377         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8378         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8379         assert_eq!(res.htlc_minimum_msat, 1);
8380
8381         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8382         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8383         assert_eq!(res.htlc_minimum_msat, 1);
8384 }
8385
8386 #[test]
8387 fn test_simple_mpp() {
8388         // Simple test of sending a multi-path payment.
8389         let chanmon_cfgs = create_chanmon_cfgs(4);
8390         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8391         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8392         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8393
8394         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8395         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8396         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8397         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8398         let logger = test_utils::TestLogger::new();
8399
8400         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8401         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8402         let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8403         let path = route.paths[0].clone();
8404         route.paths.push(path);
8405         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8406         route.paths[0][0].short_channel_id = chan_1_id;
8407         route.paths[0][1].short_channel_id = chan_3_id;
8408         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8409         route.paths[1][0].short_channel_id = chan_2_id;
8410         route.paths[1][1].short_channel_id = chan_4_id;
8411         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8412         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8413 }
8414
8415 #[test]
8416 fn test_preimage_storage() {
8417         // Simple test of payment preimage storage allowing no client-side storage to claim payments
8418         let chanmon_cfgs = create_chanmon_cfgs(2);
8419         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8420         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8421         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8422
8423         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8424
8425         {
8426                 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8427
8428                 let logger = test_utils::TestLogger::new();
8429                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8430                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8431                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8432                 check_added_monitors!(nodes[0], 1);
8433                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8434                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8435                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8436                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8437         }
8438         // Note that after leaving the above scope we have no knowledge of any arguments or return
8439         // values from previous calls.
8440         expect_pending_htlcs_forwardable!(nodes[1]);
8441         let events = nodes[1].node.get_and_clear_pending_events();
8442         assert_eq!(events.len(), 1);
8443         match events[0] {
8444                 Event::PaymentReceived { payment_preimage, user_payment_id, .. } => {
8445                         assert_eq!(user_payment_id, 42);
8446                         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8447                 },
8448                 _ => panic!("Unexpected event"),
8449         }
8450 }
8451
8452 #[test]
8453 fn test_secret_timeout() {
8454         // Simple test of payment secret storage time outs
8455         let chanmon_cfgs = create_chanmon_cfgs(2);
8456         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8457         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8458         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8459
8460         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8461
8462         let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8463
8464         // We should fail to register the same payment hash twice, at least until we've connected a
8465         // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8466         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8467                 assert_eq!(err, "Duplicate payment hash");
8468         } else { panic!(); }
8469         let mut block = {
8470                 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8471                 Block {
8472                         header: BlockHeader {
8473                                 version: 0x2000000,
8474                                 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8475                                 merkle_root: Default::default(),
8476                                 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8477                         txdata: vec![],
8478                 }
8479         };
8480         connect_block(&nodes[1], &block);
8481         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8482                 assert_eq!(err, "Duplicate payment hash");
8483         } else { panic!(); }
8484
8485         // If we then connect the second block, we should be able to register the same payment hash
8486         // again with a different user_payment_id (this time getting a new payment secret).
8487         block.header.prev_blockhash = block.header.block_hash();
8488         block.header.time += 1;
8489         connect_block(&nodes[1], &block);
8490         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8491         assert_ne!(payment_secret_1, our_payment_secret);
8492
8493         {
8494                 let logger = test_utils::TestLogger::new();
8495                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8496                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8497                 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8498                 check_added_monitors!(nodes[0], 1);
8499                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8500                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8501                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8502                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8503         }
8504         // Note that after leaving the above scope we have no knowledge of any arguments or return
8505         // values from previous calls.
8506         expect_pending_htlcs_forwardable!(nodes[1]);
8507         let events = nodes[1].node.get_and_clear_pending_events();
8508         assert_eq!(events.len(), 1);
8509         match events[0] {
8510                 Event::PaymentReceived { payment_preimage, payment_secret, user_payment_id, .. } => {
8511                         assert!(payment_preimage.is_none());
8512                         assert_eq!(user_payment_id, 42);
8513                         assert_eq!(payment_secret, our_payment_secret);
8514                         // We don't actually have the payment preimage with which to claim this payment!
8515                 },
8516                 _ => panic!("Unexpected event"),
8517         }
8518 }
8519
8520 #[test]
8521 fn test_bad_secret_hash() {
8522         // Simple test of unregistered payment hash/invalid payment secret handling
8523         let chanmon_cfgs = create_chanmon_cfgs(2);
8524         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8525         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8526         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8527
8528         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8529
8530         let random_payment_hash = PaymentHash([42; 32]);
8531         let random_payment_secret = PaymentSecret([43; 32]);
8532         let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8533
8534         let logger = test_utils::TestLogger::new();
8535         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8536         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8537
8538         // All the below cases should end up being handled exactly identically, so we macro the
8539         // resulting events.
8540         macro_rules! handle_unknown_invalid_payment_data {
8541                 () => {
8542                         check_added_monitors!(nodes[0], 1);
8543                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8544                         let payment_event = SendEvent::from_event(events.pop().unwrap());
8545                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8546                         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8547
8548                         // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8549                         // again to process the pending backwards-failure of the HTLC
8550                         expect_pending_htlcs_forwardable!(nodes[1]);
8551                         expect_pending_htlcs_forwardable!(nodes[1]);
8552                         check_added_monitors!(nodes[1], 1);
8553
8554                         // We should fail the payment back
8555                         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8556                         match events.pop().unwrap() {
8557                                 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8558                                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8559                                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8560                                 },
8561                                 _ => panic!("Unexpected event"),
8562                         }
8563                 }
8564         }
8565
8566         let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8567         // Error data is the HTLC value (100,000) and current block height
8568         let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8569
8570         // Send a payment with the right payment hash but the wrong payment secret
8571         nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8572         handle_unknown_invalid_payment_data!();
8573         expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8574
8575         // Send a payment with a random payment hash, but the right payment secret
8576         nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8577         handle_unknown_invalid_payment_data!();
8578         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8579
8580         // Send a payment with a random payment hash and random payment secret
8581         nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8582         handle_unknown_invalid_payment_data!();
8583         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8584 }
8585
8586 #[test]
8587 fn test_update_err_monitor_lockdown() {
8588         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8589         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8590         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8591         //
8592         // This scenario may happen in a watchtower setup, where watchtower process a block height
8593         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8594         // commitment at same time.
8595
8596         let chanmon_cfgs = create_chanmon_cfgs(2);
8597         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8598         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8599         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8600
8601         // Create some initial channel
8602         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8603         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8604
8605         // Rebalance the network to generate htlc in the two directions
8606         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8607
8608         // Route a HTLC from node 0 to node 1 (but don't settle)
8609         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8610
8611         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8612         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8613         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8614         let persister = test_utils::TestPersister::new();
8615         let watchtower = {
8616                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8617                 let monitor = monitors.get(&outpoint).unwrap();
8618                 let mut w = test_utils::TestVecWriter(Vec::new());
8619                 monitor.write(&mut w).unwrap();
8620                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8621                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8622                 assert!(new_monitor == *monitor);
8623                 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);
8624                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8625                 watchtower
8626         };
8627         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8628         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8629         // transaction lock time requirements here.
8630         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (header, 0));
8631         watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8632
8633         // Try to update ChannelMonitor
8634         assert!(nodes[1].node.claim_funds(preimage));
8635         check_added_monitors!(nodes[1], 1);
8636         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8637         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8638         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8639         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8640                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8641                         if let Err(_) =  watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8642                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8643                 } else { assert!(false); }
8644         } else { assert!(false); };
8645         // Our local monitor is in-sync and hasn't processed yet timeout
8646         check_added_monitors!(nodes[0], 1);
8647         let events = nodes[0].node.get_and_clear_pending_events();
8648         assert_eq!(events.len(), 1);
8649 }
8650
8651 #[test]
8652 fn test_concurrent_monitor_claim() {
8653         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8654         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8655         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8656         // state N+1 confirms. Alice claims output from state N+1.
8657
8658         let chanmon_cfgs = create_chanmon_cfgs(2);
8659         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8660         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8661         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8662
8663         // Create some initial channel
8664         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8665         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8666
8667         // Rebalance the network to generate htlc in the two directions
8668         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8669
8670         // Route a HTLC from node 0 to node 1 (but don't settle)
8671         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8672
8673         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8674         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8675         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8676         let persister = test_utils::TestPersister::new();
8677         let watchtower_alice = {
8678                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8679                 let monitor = monitors.get(&outpoint).unwrap();
8680                 let mut w = test_utils::TestVecWriter(Vec::new());
8681                 monitor.write(&mut w).unwrap();
8682                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8683                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8684                 assert!(new_monitor == *monitor);
8685                 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);
8686                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8687                 watchtower
8688         };
8689         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8690         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8691         // transaction lock time requirements here.
8692         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (header, 0));
8693         watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8694
8695         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8696         {
8697                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8698                 assert_eq!(txn.len(), 2);
8699                 txn.clear();
8700         }
8701
8702         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8703         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8704         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8705         let persister = test_utils::TestPersister::new();
8706         let watchtower_bob = {
8707                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8708                 let monitor = monitors.get(&outpoint).unwrap();
8709                 let mut w = test_utils::TestVecWriter(Vec::new());
8710                 monitor.write(&mut w).unwrap();
8711                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8712                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8713                 assert!(new_monitor == *monitor);
8714                 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);
8715                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8716                 watchtower
8717         };
8718         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8719         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8720
8721         // Route another payment to generate another update with still previous HTLC pending
8722         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8723         {
8724                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8725                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3000000 , TEST_FINAL_CLTV, &logger).unwrap();
8726                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8727         }
8728         check_added_monitors!(nodes[1], 1);
8729
8730         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8731         assert_eq!(updates.update_add_htlcs.len(), 1);
8732         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8733         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8734                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8735                         // Watchtower Alice should already have seen the block and reject the update
8736                         if let Err(_) =  watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8737                         if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8738                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8739                 } else { assert!(false); }
8740         } else { assert!(false); };
8741         // Our local monitor is in-sync and hasn't processed yet timeout
8742         check_added_monitors!(nodes[0], 1);
8743
8744         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8745         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8746         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8747
8748         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8749         let bob_state_y;
8750         {
8751                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8752                 assert_eq!(txn.len(), 2);
8753                 bob_state_y = txn[0].clone();
8754                 txn.clear();
8755         };
8756
8757         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8758         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8759         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);
8760         {
8761                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8762                 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8763                 // the onchain detection of the HTLC output
8764                 assert_eq!(htlc_txn.len(), 2);
8765                 check_spends!(htlc_txn[0], bob_state_y);
8766                 check_spends!(htlc_txn[1], bob_state_y);
8767         }
8768 }
8769
8770 #[test]
8771 fn test_pre_lockin_no_chan_closed_update() {
8772         // Test that if a peer closes a channel in response to a funding_created message we don't
8773         // generate a channel update (as the channel cannot appear on chain without a funding_signed
8774         // message).
8775         //
8776         // Doing so would imply a channel monitor update before the initial channel monitor
8777         // registration, violating our API guarantees.
8778         //
8779         // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8780         // then opening a second channel with the same funding output as the first (which is not
8781         // rejected because the first channel does not exist in the ChannelManager) and closing it
8782         // before receiving funding_signed.
8783         let chanmon_cfgs = create_chanmon_cfgs(2);
8784         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8785         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8786         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8787
8788         // Create an initial channel
8789         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8790         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8791         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8792         let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8793         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8794
8795         // Move the first channel through the funding flow...
8796         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8797
8798         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8799         check_added_monitors!(nodes[0], 0);
8800
8801         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8802         let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8803         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8804         assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8805 }
8806
8807 #[test]
8808 fn test_htlc_no_detection() {
8809         // This test is a mutation to underscore the detection logic bug we had
8810         // before #653. HTLC value routed is above the remaining balance, thus
8811         // inverting HTLC and `to_remote` output. HTLC will come second and
8812         // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8813         // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8814         // outputs order detection for correct spending children filtring.
8815
8816         let chanmon_cfgs = create_chanmon_cfgs(2);
8817         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8818         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8819         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8820
8821         // Create some initial channels
8822         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8823
8824         send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8825         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8826         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8827         assert_eq!(local_txn[0].input.len(), 1);
8828         assert_eq!(local_txn[0].output.len(), 3);
8829         check_spends!(local_txn[0], chan_1.3);
8830
8831         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8832         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8833         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8834         // We deliberately connect the local tx twice as this should provoke a failure calling
8835         // this test before #653 fix.
8836         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);
8837         check_closed_broadcast!(nodes[0], true);
8838         check_added_monitors!(nodes[0], 1);
8839         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
8840
8841         let htlc_timeout = {
8842                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8843                 assert_eq!(node_txn[1].input.len(), 1);
8844                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8845                 check_spends!(node_txn[1], local_txn[0]);
8846                 node_txn[1].clone()
8847         };
8848
8849         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8850         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8851         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8852         expect_payment_failed!(nodes[0], our_payment_hash, true);
8853 }
8854
8855 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8856         // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8857         // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8858         // Carol, Alice would be the upstream node, and Carol the downstream.)
8859         //
8860         // Steps of the test:
8861         // 1) Alice sends a HTLC to Carol through Bob.
8862         // 2) Carol doesn't settle the HTLC.
8863         // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8864         // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8865         // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8866         //    but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8867         // 5) Carol release the preimage to Bob off-chain.
8868         // 6) Bob claims the offered output on the broadcasted commitment.
8869         let chanmon_cfgs = create_chanmon_cfgs(3);
8870         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8871         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8872         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8873
8874         // Create some initial channels
8875         let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8876         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8877
8878         // Steps (1) and (2):
8879         // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8880         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8881
8882         // Check that Alice's commitment transaction now contains an output for this HTLC.
8883         let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8884         check_spends!(alice_txn[0], chan_ab.3);
8885         assert_eq!(alice_txn[0].output.len(), 2);
8886         check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8887         assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8888         assert_eq!(alice_txn.len(), 2);
8889
8890         // Steps (3) and (4):
8891         // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8892         // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8893         let mut force_closing_node = 0; // Alice force-closes
8894         if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8895         nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8896         check_closed_broadcast!(nodes[force_closing_node], true);
8897         check_added_monitors!(nodes[force_closing_node], 1);
8898         if go_onchain_before_fulfill {
8899                 let txn_to_broadcast = match broadcast_alice {
8900                         true => alice_txn.clone(),
8901                         false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8902                 };
8903                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8904                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8905                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8906                 if broadcast_alice {
8907                         check_closed_broadcast!(nodes[1], true);
8908                         check_added_monitors!(nodes[1], 1);
8909                 }
8910                 assert_eq!(bob_txn.len(), 1);
8911                 check_spends!(bob_txn[0], chan_ab.3);
8912         }
8913
8914         // Step (5):
8915         // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8916         // process of removing the HTLC from their commitment transactions.
8917         assert!(nodes[2].node.claim_funds(payment_preimage));
8918         check_added_monitors!(nodes[2], 1);
8919         let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8920         assert!(carol_updates.update_add_htlcs.is_empty());
8921         assert!(carol_updates.update_fail_htlcs.is_empty());
8922         assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8923         assert!(carol_updates.update_fee.is_none());
8924         assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8925
8926         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8927         // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8928         if !go_onchain_before_fulfill && broadcast_alice {
8929                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8930                 assert_eq!(events.len(), 1);
8931                 match events[0] {
8932                         MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8933                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8934                         },
8935                         _ => panic!("Unexpected event"),
8936                 };
8937         }
8938         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8939         // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8940         // Carol<->Bob's updated commitment transaction info.
8941         check_added_monitors!(nodes[1], 2);
8942
8943         let events = nodes[1].node.get_and_clear_pending_msg_events();
8944         assert_eq!(events.len(), 2);
8945         let bob_revocation = match events[0] {
8946                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8947                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8948                         (*msg).clone()
8949                 },
8950                 _ => panic!("Unexpected event"),
8951         };
8952         let bob_updates = match events[1] {
8953                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8954                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8955                         (*updates).clone()
8956                 },
8957                 _ => panic!("Unexpected event"),
8958         };
8959
8960         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8961         check_added_monitors!(nodes[2], 1);
8962         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8963         check_added_monitors!(nodes[2], 1);
8964
8965         let events = nodes[2].node.get_and_clear_pending_msg_events();
8966         assert_eq!(events.len(), 1);
8967         let carol_revocation = match events[0] {
8968                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8969                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8970                         (*msg).clone()
8971                 },
8972                 _ => panic!("Unexpected event"),
8973         };
8974         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8975         check_added_monitors!(nodes[1], 1);
8976
8977         // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8978         // here's where we put said channel's commitment tx on-chain.
8979         let mut txn_to_broadcast = alice_txn.clone();
8980         if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8981         if !go_onchain_before_fulfill {
8982                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8983                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8984                 // If Bob was the one to force-close, he will have already passed these checks earlier.
8985                 if broadcast_alice {
8986                         check_closed_broadcast!(nodes[1], true);
8987                         check_added_monitors!(nodes[1], 1);
8988                 }
8989                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8990                 if broadcast_alice {
8991                         // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8992                         // new block being connected. The ChannelManager being notified triggers a monitor update,
8993                         // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8994                         // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8995                         // broadcasted.
8996                         assert_eq!(bob_txn.len(), 3);
8997                         check_spends!(bob_txn[1], chan_ab.3);
8998                 } else {
8999                         assert_eq!(bob_txn.len(), 2);
9000                         check_spends!(bob_txn[0], chan_ab.3);
9001                 }
9002         }
9003
9004         // Step (6):
9005         // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
9006         // broadcasted commitment transaction.
9007         {
9008                 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
9009                 if go_onchain_before_fulfill {
9010                         // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
9011                         assert_eq!(bob_txn.len(), 2);
9012                 }
9013                 let script_weight = match broadcast_alice {
9014                         true => OFFERED_HTLC_SCRIPT_WEIGHT,
9015                         false => ACCEPTED_HTLC_SCRIPT_WEIGHT
9016                 };
9017                 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
9018                 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
9019                 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
9020                 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
9021                 if broadcast_alice && !go_onchain_before_fulfill {
9022                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
9023                         assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
9024                 } else {
9025                         check_spends!(bob_txn[1], txn_to_broadcast[0]);
9026                         assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
9027                 }
9028         }
9029 }
9030
9031 #[test]
9032 fn test_onchain_htlc_settlement_after_close() {
9033         do_test_onchain_htlc_settlement_after_close(true, true);
9034         do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
9035         do_test_onchain_htlc_settlement_after_close(true, false);
9036         do_test_onchain_htlc_settlement_after_close(false, false);
9037 }
9038
9039 #[test]
9040 fn test_duplicate_chan_id() {
9041         // Test that if a given peer tries to open a channel with the same channel_id as one that is
9042         // already open we reject it and keep the old channel.
9043         //
9044         // Previously, full_stack_target managed to figure out that if you tried to open two channels
9045         // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
9046         // the existing channel when we detect the duplicate new channel, screwing up our monitor
9047         // updating logic for the existing channel.
9048         let chanmon_cfgs = create_chanmon_cfgs(2);
9049         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9050         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9051         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9052
9053         // Create an initial channel
9054         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9055         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9056         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9057         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()));
9058
9059         // Try to create a second channel with the same temporary_channel_id as the first and check
9060         // that it is rejected.
9061         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9062         {
9063                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9064                 assert_eq!(events.len(), 1);
9065                 match events[0] {
9066                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9067                                 // Technically, at this point, nodes[1] would be justified in thinking both the
9068                                 // first (valid) and second (invalid) channels are closed, given they both have
9069                                 // the same non-temporary channel_id. However, currently we do not, so we just
9070                                 // move forward with it.
9071                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9072                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9073                         },
9074                         _ => panic!("Unexpected event"),
9075                 }
9076         }
9077
9078         // Move the first channel through the funding flow...
9079         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
9080
9081         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9082         check_added_monitors!(nodes[0], 0);
9083
9084         let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9085         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9086         {
9087                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9088                 assert_eq!(added_monitors.len(), 1);
9089                 assert_eq!(added_monitors[0].0, funding_output);
9090                 added_monitors.clear();
9091         }
9092         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9093
9094         let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
9095         let channel_id = funding_outpoint.to_channel_id();
9096
9097         // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
9098         // temporary one).
9099
9100         // First try to open a second channel with a temporary channel id equal to the txid-based one.
9101         // Technically this is allowed by the spec, but we don't support it and there's little reason
9102         // to. Still, it shouldn't cause any other issues.
9103         open_chan_msg.temporary_channel_id = channel_id;
9104         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9105         {
9106                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9107                 assert_eq!(events.len(), 1);
9108                 match events[0] {
9109                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9110                                 // Technically, at this point, nodes[1] would be justified in thinking both
9111                                 // channels are closed, but currently we do not, so we just move forward with it.
9112                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9113                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9114                         },
9115                         _ => panic!("Unexpected event"),
9116                 }
9117         }
9118
9119         // Now try to create a second channel which has a duplicate funding output.
9120         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9121         let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9122         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
9123         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()));
9124         create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
9125
9126         let funding_created = {
9127                 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
9128                 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
9129                 let logger = test_utils::TestLogger::new();
9130                 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
9131         };
9132         check_added_monitors!(nodes[0], 0);
9133         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
9134         // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
9135         // still needs to be cleared here.
9136         check_added_monitors!(nodes[1], 1);
9137
9138         // ...still, nodes[1] will reject the duplicate channel.
9139         {
9140                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9141                 assert_eq!(events.len(), 1);
9142                 match events[0] {
9143                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9144                                 // Technically, at this point, nodes[1] would be justified in thinking both
9145                                 // channels are closed, but currently we do not, so we just move forward with it.
9146                                 assert_eq!(msg.channel_id, channel_id);
9147                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9148                         },
9149                         _ => panic!("Unexpected event"),
9150                 }
9151         }
9152
9153         // finally, finish creating the original channel and send a payment over it to make sure
9154         // everything is functional.
9155         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9156         {
9157                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9158                 assert_eq!(added_monitors.len(), 1);
9159                 assert_eq!(added_monitors[0].0, funding_output);
9160                 added_monitors.clear();
9161         }
9162
9163         let events_4 = nodes[0].node.get_and_clear_pending_events();
9164         assert_eq!(events_4.len(), 0);
9165         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9166         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
9167
9168         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9169         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9170         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9171         send_payment(&nodes[0], &[&nodes[1]], 8000000);
9172 }
9173
9174 #[test]
9175 fn test_error_chans_closed() {
9176         // Test that we properly handle error messages, closing appropriate channels.
9177         //
9178         // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9179         // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9180         // we can test various edge cases around it to ensure we don't regress.
9181         let chanmon_cfgs = create_chanmon_cfgs(3);
9182         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9183         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9184         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9185
9186         // Create some initial channels
9187         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9188         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9189         let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9190
9191         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9192         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9193         assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9194
9195         // Closing a channel from a different peer has no effect
9196         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9197         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9198
9199         // Closing one channel doesn't impact others
9200         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9201         check_added_monitors!(nodes[0], 1);
9202         check_closed_broadcast!(nodes[0], false);
9203         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9204         assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9205         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);
9206         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);
9207
9208         // A null channel ID should close all channels
9209         let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9210         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9211         check_added_monitors!(nodes[0], 2);
9212         let events = nodes[0].node.get_and_clear_pending_msg_events();
9213         assert_eq!(events.len(), 2);
9214         match events[0] {
9215                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9216                         assert_eq!(msg.contents.flags & 2, 2);
9217                 },
9218                 _ => panic!("Unexpected event"),
9219         }
9220         match events[1] {
9221                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9222                         assert_eq!(msg.contents.flags & 2, 2);
9223                 },
9224                 _ => panic!("Unexpected event"),
9225         }
9226         // Note that at this point users of a standard PeerHandler will end up calling
9227         // peer_disconnected with no_connection_possible set to false, duplicating the
9228         // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9229         // users with their own peer handling logic. We duplicate the call here, however.
9230         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9231         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9232
9233         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9234         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9235         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9236 }
9237
9238 #[test]
9239 fn test_invalid_funding_tx() {
9240         // Test that we properly handle invalid funding transactions sent to us from a peer.
9241         //
9242         // Previously, all other major lightning implementations had failed to properly sanitize
9243         // funding transactions from their counterparties, leading to a multi-implementation critical
9244         // security vulnerability (though we always sanitized properly, we've previously had
9245         // un-released crashes in the sanitization process).
9246         let chanmon_cfgs = create_chanmon_cfgs(2);
9247         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9248         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9249         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9250
9251         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9252         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()));
9253         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()));
9254
9255         let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9256         for output in tx.output.iter_mut() {
9257                 // Make the confirmed funding transaction have a bogus script_pubkey
9258                 output.script_pubkey = bitcoin::Script::new();
9259         }
9260
9261         nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9262         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()));
9263         check_added_monitors!(nodes[1], 1);
9264
9265         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()));
9266         check_added_monitors!(nodes[0], 1);
9267
9268         let events_1 = nodes[0].node.get_and_clear_pending_events();
9269         assert_eq!(events_1.len(), 0);
9270
9271         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9272         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9273         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9274
9275         confirm_transaction_at(&nodes[1], &tx, 1);
9276         check_added_monitors!(nodes[1], 1);
9277         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9278         assert_eq!(events_2.len(), 1);
9279         if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9280                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9281                 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9282                         assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9283                 } else { panic!(); }
9284         } else { panic!(); }
9285         assert_eq!(nodes[1].node.list_channels().len(), 0);
9286 }
9287
9288 fn do_test_tx_confirmed_skipping_blocks_immediate_broadcast(test_height_before_timelock: bool) {
9289         // In the first version of the chain::Confirm interface, after a refactor was made to not
9290         // broadcast CSV-locked transactions until their CSV lock is up, we wouldn't reliably broadcast
9291         // transactions after a `transactions_confirmed` call. Specifically, if the chain, provided via
9292         // `best_block_updated` is at height N, and a transaction output which we wish to spend at
9293         // height N-1 (due to a CSV to height N-1) is provided at height N, we will not broadcast the
9294         // spending transaction until height N+1 (or greater). This was due to the way
9295         // `ChannelMonitor::transactions_confirmed` worked, only checking if we should broadcast a
9296         // spending transaction at the height the input transaction was confirmed at, not whether we
9297         // should broadcast a spending transaction at the current height.
9298         // A second, similar, issue involved failing HTLCs backwards - because we only provided the
9299         // height at which transactions were confirmed to `OnchainTx::update_claims_view`, it wasn't
9300         // aware that the anti-reorg-delay had, in fact, already expired, waiting to fail-backwards
9301         // until we learned about an additional block.
9302         //
9303         // As an additional check, if `test_height_before_timelock` is set, we instead test that we
9304         // aren't broadcasting transactions too early (ie not broadcasting them at all).
9305         let chanmon_cfgs = create_chanmon_cfgs(3);
9306         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9307         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9308         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9309         *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
9310
9311         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
9312         let (chan_announce, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
9313         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
9314         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
9315         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
9316
9317         nodes[1].node.force_close_channel(&channel_id).unwrap();
9318         check_closed_broadcast!(nodes[1], true);
9319         check_added_monitors!(nodes[1], 1);
9320         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9321         assert_eq!(node_txn.len(), 1);
9322
9323         let conf_height = nodes[1].best_block_info().1;
9324         if !test_height_before_timelock {
9325                 connect_blocks(&nodes[1], 24 * 6);
9326         }
9327         nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9328                 &nodes[1].get_block_header(conf_height), &[(0, &node_txn[0])], conf_height);
9329         if test_height_before_timelock {
9330                 // If we confirmed the close transaction, but timelocks have not yet expired, we should not
9331                 // generate any events or broadcast any transactions
9332                 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
9333                 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
9334         } else {
9335                 // We should broadcast an HTLC transaction spending our funding transaction first
9336                 let spending_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9337                 assert_eq!(spending_txn.len(), 2);
9338                 assert_eq!(spending_txn[0], node_txn[0]);
9339                 check_spends!(spending_txn[1], node_txn[0]);
9340                 // We should also generate a SpendableOutputs event with the to_self output (as its
9341                 // timelock is up).
9342                 let descriptor_spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
9343                 assert_eq!(descriptor_spend_txn.len(), 1);
9344
9345                 // If we also discover that the HTLC-Timeout transaction was confirmed some time ago, we
9346                 // should immediately fail-backwards the HTLC to the previous hop, without waiting for an
9347                 // additional block built on top of the current chain.
9348                 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9349                         &nodes[1].get_block_header(conf_height + 1), &[(0, &spending_txn[1])], conf_height + 1);
9350                 expect_pending_htlcs_forwardable!(nodes[1]);
9351                 check_added_monitors!(nodes[1], 1);
9352
9353                 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9354                 assert!(updates.update_add_htlcs.is_empty());
9355                 assert!(updates.update_fulfill_htlcs.is_empty());
9356                 assert_eq!(updates.update_fail_htlcs.len(), 1);
9357                 assert!(updates.update_fail_malformed_htlcs.is_empty());
9358                 assert!(updates.update_fee.is_none());
9359                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9360                 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9361                 expect_payment_failed!(nodes[0], payment_hash, false);
9362                 expect_payment_failure_chan_update!(nodes[0], chan_announce.contents.short_channel_id, true);
9363         }
9364 }
9365 #[test]
9366 fn test_tx_confirmed_skipping_blocks_immediate_broadcast() {
9367         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(false);
9368         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(true);
9369 }