_ 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::Listen;
  16 use chain::Watch;
  17 use chain::channelmonitor;
  18 use chain::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
  19 use chain::transaction::OutPoint;
  20 use chain::keysinterface::{KeysInterface, BaseSign};
  21 use ln::{PaymentPreimage, PaymentSecret, PaymentHash};
  22 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
  23 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, BREAKDOWN_TIMEOUT};
  24 use ln::channel::{Channel, ChannelError};
  25 use ln::{chan_utils, onion_utils};
  26 use routing::router::{Route, RouteHop, get_route};
  27 use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
  28 use ln::msgs;
  29 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
  30 use util::enforcing_trait_impls::EnforcingSigner;
  31 use util::{byte_utils, test_utils};
  32 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
  33 use util::errors::APIError;
  34 use util::ser::{Writeable, ReadableArgs};
  35 use util::config::UserConfig;
  36
  37 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
  38 use bitcoin::hash_types::{Txid, BlockHash};
  39 use bitcoin::blockdata::block::{Block, BlockHeader};
  40 use bitcoin::blockdata::script::Builder;
  41 use bitcoin::blockdata::opcodes;
  42 use bitcoin::blockdata::constants::genesis_block;
  43 use bitcoin::network::constants::Network;
  44
  45 use bitcoin::hashes::sha256::Hash as Sha256;
  46 use bitcoin::hashes::Hash;
  47
  48 use bitcoin::secp256k1::{Secp256k1, Message};
  49 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
  50
  51 use regex;
  52
  53 use std::collections::{BTreeSet, HashMap, HashSet};
  54 use core::default::Default;
  55 use std::sync::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         let events = nodes[0].node.get_and_clear_pending_msg_events();
1363         assert_eq!(events.len(), 1);
1364         match events[0] {
1365                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1366                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1367                 },
1368                 _ => panic!("Unexpected event"),
1369         }
1370
1371         expect_payment_failed!(nodes[0], payment_hash_2, false);
1372
1373         // Now forward all the pending HTLCs and claim them back
1374         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1375         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1376         check_added_monitors!(nodes[2], 1);
1377
1378         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1379         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1380         check_added_monitors!(nodes[1], 1);
1381         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1382
1383         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1384         check_added_monitors!(nodes[1], 1);
1385         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1386
1387         for ref update in as_updates.update_add_htlcs.iter() {
1388                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1389         }
1390         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1391         check_added_monitors!(nodes[2], 1);
1392         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1393         check_added_monitors!(nodes[2], 1);
1394         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1395
1396         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1397         check_added_monitors!(nodes[1], 1);
1398         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1399         check_added_monitors!(nodes[1], 1);
1400         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1401
1402         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1403         check_added_monitors!(nodes[2], 1);
1404
1405         expect_pending_htlcs_forwardable!(nodes[2]);
1406
1407         let events = nodes[2].node.get_and_clear_pending_events();
1408         assert_eq!(events.len(), payments.len());
1409         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1410                 match event {
1411                         &Event::PaymentReceived { ref payment_hash, .. } => {
1412                                 assert_eq!(*payment_hash, *hash);
1413                         },
1414                         _ => panic!("Unexpected event"),
1415                 };
1416         }
1417
1418         for (preimage, _) in payments.drain(..) {
1419                 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1420         }
1421
1422         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1423 }
1424
1425 #[test]
1426 fn duplicate_htlc_test() {
1427         // Test that we accept duplicate payment_hash HTLCs across the network and that
1428         // claiming/failing them are all separate and don't affect each other
1429         let chanmon_cfgs = create_chanmon_cfgs(6);
1430         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1431         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1432         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1433
1434         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1435         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1436         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1437         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1438         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1439         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1440
1441         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1442
1443         *nodes[0].network_payment_count.borrow_mut() -= 1;
1444         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1445
1446         *nodes[0].network_payment_count.borrow_mut() -= 1;
1447         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1448
1449         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1450         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1451         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1452 }
1453
1454 #[test]
1455 fn test_duplicate_htlc_different_direction_onchain() {
1456         // Test that ChannelMonitor doesn't generate 2 preimage txn
1457         // when we have 2 HTLCs with same preimage that go across a node
1458         // in opposite directions, even with the same payment secret.
1459         let chanmon_cfgs = create_chanmon_cfgs(2);
1460         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1461         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1462         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1463
1464         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1465         let logger = test_utils::TestLogger::new();
1466
1467         // balancing
1468         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1469
1470         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1471
1472         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1473         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();
1474         let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
1475         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1476
1477         // Provide preimage to node 0 by claiming payment
1478         nodes[0].node.claim_funds(payment_preimage);
1479         check_added_monitors!(nodes[0], 1);
1480
1481         // Broadcast node 1 commitment txn
1482         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1483
1484         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1485         let mut has_both_htlcs = 0; // check htlcs match ones committed
1486         for outp in remote_txn[0].output.iter() {
1487                 if outp.value == 800_000 / 1000 {
1488                         has_both_htlcs += 1;
1489                 } else if outp.value == 900_000 / 1000 {
1490                         has_both_htlcs += 1;
1491                 }
1492         }
1493         assert_eq!(has_both_htlcs, 2);
1494
1495         mine_transaction(&nodes[0], &remote_txn[0]);
1496         check_added_monitors!(nodes[0], 1);
1497
1498         // Check we only broadcast 1 timeout tx
1499         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1500         let htlc_pair = if claim_txn[0].output[0].value == 800_000 / 1000 { (claim_txn[0].clone(), claim_txn[1].clone()) } else { (claim_txn[1].clone(), claim_txn[0].clone()) };
1501         assert_eq!(claim_txn.len(), 5);
1502         check_spends!(claim_txn[2], chan_1.3);
1503         check_spends!(claim_txn[3], claim_txn[2]);
1504         assert_eq!(htlc_pair.0.input.len(), 1);
1505         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1506         check_spends!(htlc_pair.0, remote_txn[0]);
1507         assert_eq!(htlc_pair.1.input.len(), 1);
1508         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1509         check_spends!(htlc_pair.1, remote_txn[0]);
1510
1511         let events = nodes[0].node.get_and_clear_pending_msg_events();
1512         assert_eq!(events.len(), 3);
1513         for e in events {
1514                 match e {
1515                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1516                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1517                                 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1518                                 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1519                         },
1520                         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, .. } } => {
1521                                 assert!(update_add_htlcs.is_empty());
1522                                 assert!(update_fail_htlcs.is_empty());
1523                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1524                                 assert!(update_fail_malformed_htlcs.is_empty());
1525                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1526                         },
1527                         _ => panic!("Unexpected event"),
1528                 }
1529         }
1530 }
1531
1532 #[test]
1533 fn test_basic_channel_reserve() {
1534         let chanmon_cfgs = create_chanmon_cfgs(2);
1535         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1536         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1537         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1538         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1539         let logger = test_utils::TestLogger::new();
1540
1541         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1542         let channel_reserve = chan_stat.channel_reserve_msat;
1543
1544         // The 2* and +1 are for the fee spike reserve.
1545         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
1546         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1547         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1548         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1549         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();
1550         let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).err().unwrap();
1551         match err {
1552                 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1553                         match &fails[0] {
1554                                 &APIError::ChannelUnavailable{ref err} =>
1555                                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1556                                 _ => panic!("Unexpected error variant"),
1557                         }
1558                 },
1559                 _ => panic!("Unexpected error variant"),
1560         }
1561         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1562         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);
1563
1564         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1565 }
1566
1567 #[test]
1568 fn test_fee_spike_violation_fails_htlc() {
1569         let chanmon_cfgs = create_chanmon_cfgs(2);
1570         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1571         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1572         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1573         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1574
1575         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1576         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1577         let secp_ctx = Secp256k1::new();
1578         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1579
1580         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1581
1582         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1583         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height).unwrap();
1584         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1585         let msg = msgs::UpdateAddHTLC {
1586                 channel_id: chan.2,
1587                 htlc_id: 0,
1588                 amount_msat: htlc_msat,
1589                 payment_hash: payment_hash,
1590                 cltv_expiry: htlc_cltv,
1591                 onion_routing_packet: onion_packet,
1592         };
1593
1594         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1595
1596         // Now manually create the commitment_signed message corresponding to the update_add
1597         // nodes[0] just sent. In the code for construction of this message, "local" refers
1598         // to the sender of the message, and "remote" refers to the receiver.
1599
1600         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1601
1602         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1603
1604         // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1605         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1606         let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point) = {
1607                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1608                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1609                 let chan_signer = local_chan.get_signer();
1610                 let pubkeys = chan_signer.pubkeys();
1611                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1612                  chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1613                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx))
1614         };
1615         let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point) = {
1616                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1617                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1618                 let chan_signer = remote_chan.get_signer();
1619                 let pubkeys = chan_signer.pubkeys();
1620                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1621                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx))
1622         };
1623
1624         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1625         let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1626                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1627
1628         // Build the remote commitment transaction so we can sign it, and then later use the
1629         // signature for the commitment_signed message.
1630         let local_chan_balance = 1313;
1631
1632         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1633                 offered: false,
1634                 amount_msat: 3460001,
1635                 cltv_expiry: htlc_cltv,
1636                 payment_hash,
1637                 transaction_output_index: Some(1),
1638         };
1639
1640         let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1641
1642         let res = {
1643                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1644                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1645                 let local_chan_signer = local_chan.get_signer();
1646                 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1647                         commitment_number,
1648                         95000,
1649                         local_chan_balance,
1650                         commit_tx_keys.clone(),
1651                         feerate_per_kw,
1652                         &mut vec![(accepted_htlc_info, ())],
1653                         &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1654                 );
1655                 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1656         };
1657
1658         let commit_signed_msg = msgs::CommitmentSigned {
1659                 channel_id: chan.2,
1660                 signature: res.0,
1661                 htlc_signatures: res.1
1662         };
1663
1664         // Send the commitment_signed message to the nodes[1].
1665         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1666         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1667
1668         // Send the RAA to nodes[1].
1669         let raa_msg = msgs::RevokeAndACK {
1670                 channel_id: chan.2,
1671                 per_commitment_secret: local_secret,
1672                 next_per_commitment_point: next_local_point
1673         };
1674         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1675
1676         let events = nodes[1].node.get_and_clear_pending_msg_events();
1677         assert_eq!(events.len(), 1);
1678         // Make sure the HTLC failed in the way we expect.
1679         match events[0] {
1680                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1681                         assert_eq!(update_fail_htlcs.len(), 1);
1682                         update_fail_htlcs[0].clone()
1683                 },
1684                 _ => panic!("Unexpected event"),
1685         };
1686         nodes[1].logger.assert_log("lightning::ln::channel".to_string(), "Attempting to fail HTLC due to fee spike buffer violation".to_string(), 1);
1687
1688         check_added_monitors!(nodes[1], 2);
1689 }
1690
1691 #[test]
1692 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1693         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1694         // Set the fee rate for the channel very high, to the point where the fundee
1695         // sending any above-dust amount would result in a channel reserve violation.
1696         // In this test we check that we would be prevented from sending an HTLC in
1697         // this situation.
1698         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1699         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1700         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1701         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1702         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1703         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1704
1705         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 4843000);
1706         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1707                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1708         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1709         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);
1710 }
1711
1712 #[test]
1713 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1714         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1715         // Set the fee rate for the channel very high, to the point where the funder
1716         // receiving 1 update_add_htlc would result in them closing the channel due
1717         // to channel reserve violation. This close could also happen if the fee went
1718         // up a more realistic amount, but many HTLCs were outstanding at the time of
1719         // the update_add_htlc.
1720         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1721         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1722         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1723         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1724         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1725         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1726
1727         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1728         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1729         let secp_ctx = Secp256k1::new();
1730         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1731         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1732         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1733         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height).unwrap();
1734         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1735         let msg = msgs::UpdateAddHTLC {
1736                 channel_id: chan.2,
1737                 htlc_id: 1,
1738                 amount_msat: htlc_msat + 1,
1739                 payment_hash: payment_hash,
1740                 cltv_expiry: htlc_cltv,
1741                 onion_routing_packet: onion_packet,
1742         };
1743
1744         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1745         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1746         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);
1747         assert_eq!(nodes[0].node.list_channels().len(), 0);
1748         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1749         assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1750         check_added_monitors!(nodes[0], 1);
1751 }
1752
1753 #[test]
1754 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1755         // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1756         // calculating our commitment transaction fee (this was previously broken).
1757         let chanmon_cfgs = create_chanmon_cfgs(2);
1758         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1759         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1760         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1761
1762         // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1763         // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1764         // transaction fee with 0 HTLCs (183 sats)).
1765         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98817000, InitFeatures::known(), InitFeatures::known());
1766
1767         let dust_amt = 329000; // Dust amount
1768         // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1769         // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1770         // commitment transaction fee.
1771         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1772 }
1773
1774 #[test]
1775 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1776         // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1777         // calculating our counterparty's commitment transaction fee (this was previously broken).
1778         let chanmon_cfgs = create_chanmon_cfgs(2);
1779         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1780         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1781         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1782         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1783
1784         let payment_amt = 46000; // Dust amount
1785         // In the previous code, these first four payments would succeed.
1786         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1787         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1788         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1789         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1790
1791         // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1792         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1793         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1794         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1795         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1796         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1797
1798         // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1799         // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1800         // transaction fee and therefore perceived this next payment as a channel reserve violation.
1801         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1802 }
1803
1804 #[test]
1805 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1806         let chanmon_cfgs = create_chanmon_cfgs(3);
1807         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1808         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1809         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1810         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1811         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1812
1813         let feemsat = 239;
1814         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1815         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1816         let feerate = get_feerate!(nodes[0], chan.2);
1817
1818         // Add a 2* and +1 for the fee spike reserve.
1819         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1820         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;
1821         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1822
1823         // Add a pending HTLC.
1824         let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1825         let payment_event_1 = {
1826                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1827                 check_added_monitors!(nodes[0], 1);
1828
1829                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1830                 assert_eq!(events.len(), 1);
1831                 SendEvent::from_event(events.remove(0))
1832         };
1833         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1834
1835         // Attempt to trigger a channel reserve violation --> payment failure.
1836         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1837         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;
1838         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1839         let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1840
1841         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1842         let secp_ctx = Secp256k1::new();
1843         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1844         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1845         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1846         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1847         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1848         let msg = msgs::UpdateAddHTLC {
1849                 channel_id: chan.2,
1850                 htlc_id: 1,
1851                 amount_msat: htlc_msat + 1,
1852                 payment_hash: our_payment_hash_1,
1853                 cltv_expiry: htlc_cltv,
1854                 onion_routing_packet: onion_packet,
1855         };
1856
1857         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1858         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1859         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1860         assert_eq!(nodes[1].node.list_channels().len(), 1);
1861         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1862         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1863         check_added_monitors!(nodes[1], 1);
1864 }
1865
1866 #[test]
1867 fn test_inbound_outbound_capacity_is_not_zero() {
1868         let chanmon_cfgs = create_chanmon_cfgs(2);
1869         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1870         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1871         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1872         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1873         let channels0 = node_chanmgrs[0].list_channels();
1874         let channels1 = node_chanmgrs[1].list_channels();
1875         assert_eq!(channels0.len(), 1);
1876         assert_eq!(channels1.len(), 1);
1877
1878         assert_eq!(channels0[0].inbound_capacity_msat, 95000000);
1879         assert_eq!(channels1[0].outbound_capacity_msat, 95000000);
1880
1881         assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000);
1882         assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000);
1883 }
1884
1885 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1886         (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1887 }
1888
1889 #[test]
1890 fn test_channel_reserve_holding_cell_htlcs() {
1891         let chanmon_cfgs = create_chanmon_cfgs(3);
1892         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1893         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1894         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1895         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1896         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1897
1898         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1899         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1900
1901         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1902         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1903
1904         macro_rules! expect_forward {
1905                 ($node: expr) => {{
1906                         let mut events = $node.node.get_and_clear_pending_msg_events();
1907                         assert_eq!(events.len(), 1);
1908                         check_added_monitors!($node, 1);
1909                         let payment_event = SendEvent::from_event(events.remove(0));
1910                         payment_event
1911                 }}
1912         }
1913
1914         let feemsat = 239; // somehow we know?
1915         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1916         let feerate = get_feerate!(nodes[0], chan_1.2);
1917
1918         let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1919
1920         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1921         {
1922                 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1923                 route.paths[0].last_mut().unwrap().fee_msat += 1;
1924                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1925                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1926                         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)));
1927                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1928                 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);
1929         }
1930
1931         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1932         // nodes[0]'s wealth
1933         loop {
1934                 let amt_msat = recv_value_0 + total_fee_msat;
1935                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1936                 // Also, ensure that each payment has enough to be over the dust limit to
1937                 // ensure it'll be included in each commit tx fee calculation.
1938                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1939                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1940                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1941                         break;
1942                 }
1943                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1944
1945                 let (stat01_, stat11_, stat12_, stat22_) = (
1946                         get_channel_value_stat!(nodes[0], chan_1.2),
1947                         get_channel_value_stat!(nodes[1], chan_1.2),
1948                         get_channel_value_stat!(nodes[1], chan_2.2),
1949                         get_channel_value_stat!(nodes[2], chan_2.2),
1950                 );
1951
1952                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1953                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1954                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1955                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1956                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1957         }
1958
1959         // adding pending output.
1960         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1961         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1962         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1963         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1964         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1965         // cases where 1 msat over X amount will cause a payment failure, but anything less than
1966         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1967         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1968         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1969         // policy.
1970         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1971         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1972         let amt_msat_1 = recv_value_1 + total_fee_msat;
1973
1974         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);
1975         let payment_event_1 = {
1976                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1977                 check_added_monitors!(nodes[0], 1);
1978
1979                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1980                 assert_eq!(events.len(), 1);
1981                 SendEvent::from_event(events.remove(0))
1982         };
1983         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1984
1985         // channel reserve test with htlc pending output > 0
1986         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1987         {
1988                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
1989                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1990                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1991                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1992         }
1993
1994         // split the rest to test holding cell
1995         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1996         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
1997         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
1998         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
1999         {
2000                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2001                 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);
2002         }
2003
2004         // now see if they go through on both sides
2005         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);
2006         // but this will stuck in the holding cell
2007         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
2008         check_added_monitors!(nodes[0], 0);
2009         let events = nodes[0].node.get_and_clear_pending_events();
2010         assert_eq!(events.len(), 0);
2011
2012         // test with outbound holding cell amount > 0
2013         {
2014                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
2015                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2016                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2017                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2018                 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);
2019         }
2020
2021         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);
2022         // this will also stuck in the holding cell
2023         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
2024         check_added_monitors!(nodes[0], 0);
2025         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2026         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2027
2028         // flush the pending htlc
2029         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2030         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2031         check_added_monitors!(nodes[1], 1);
2032
2033         // the pending htlc should be promoted to committed
2034         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2035         check_added_monitors!(nodes[0], 1);
2036         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2037
2038         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2039         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2040         // No commitment_signed so get_event_msg's assert(len == 1) passes
2041         check_added_monitors!(nodes[0], 1);
2042
2043         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2044         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2045         check_added_monitors!(nodes[1], 1);
2046
2047         expect_pending_htlcs_forwardable!(nodes[1]);
2048
2049         let ref payment_event_11 = expect_forward!(nodes[1]);
2050         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2051         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2052
2053         expect_pending_htlcs_forwardable!(nodes[2]);
2054         expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
2055
2056         // flush the htlcs in the holding cell
2057         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2058         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2059         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2060         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2061         expect_pending_htlcs_forwardable!(nodes[1]);
2062
2063         let ref payment_event_3 = expect_forward!(nodes[1]);
2064         assert_eq!(payment_event_3.msgs.len(), 2);
2065         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2066         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2067
2068         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2069         expect_pending_htlcs_forwardable!(nodes[2]);
2070
2071         let events = nodes[2].node.get_and_clear_pending_events();
2072         assert_eq!(events.len(), 2);
2073         match events[0] {
2074                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2075                         assert_eq!(our_payment_hash_21, *payment_hash);
2076                         assert!(payment_preimage.is_none());
2077                         assert_eq!(our_payment_secret_21, *payment_secret);
2078                         assert_eq!(recv_value_21, amt);
2079                 },
2080                 _ => panic!("Unexpected event"),
2081         }
2082         match events[1] {
2083                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2084                         assert_eq!(our_payment_hash_22, *payment_hash);
2085                         assert!(payment_preimage.is_none());
2086                         assert_eq!(our_payment_secret_22, *payment_secret);
2087                         assert_eq!(recv_value_22, amt);
2088                 },
2089                 _ => panic!("Unexpected event"),
2090         }
2091
2092         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
2093         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
2094         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
2095
2096         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2097         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2098         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
2099
2100         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2101         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);
2102         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2103         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2104         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2105
2106         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2107         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2108 }
2109
2110 #[test]
2111 fn channel_reserve_in_flight_removes() {
2112         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2113         // can send to its counterparty, but due to update ordering, the other side may not yet have
2114         // considered those HTLCs fully removed.
2115         // This tests that we don't count HTLCs which will not be included in the next remote
2116         // commitment transaction towards the reserve value (as it implies no commitment transaction
2117         // will be generated which violates the remote reserve value).
2118         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2119         // To test this we:
2120         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2121         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2122         //    you only consider the value of the first HTLC, it may not),
2123         //  * start routing a third HTLC from A to B,
2124         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2125         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2126         //  * deliver the first fulfill from B
2127         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2128         //    claim,
2129         //  * deliver A's response CS and RAA.
2130         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2131         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
2132         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2133         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2134         let chanmon_cfgs = create_chanmon_cfgs(2);
2135         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2136         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2137         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2138         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2139         let logger = test_utils::TestLogger::new();
2140
2141         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2142         // Route the first two HTLCs.
2143         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2144         let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2145
2146         // Start routing the third HTLC (this is just used to get everyone in the right state).
2147         let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
2148         let send_1 = {
2149                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2150                 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();
2151                 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
2152                 check_added_monitors!(nodes[0], 1);
2153                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2154                 assert_eq!(events.len(), 1);
2155                 SendEvent::from_event(events.remove(0))
2156         };
2157
2158         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2159         // initial fulfill/CS.
2160         assert!(nodes[1].node.claim_funds(payment_preimage_1));
2161         check_added_monitors!(nodes[1], 1);
2162         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2163
2164         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2165         // remove the second HTLC when we send the HTLC back from B to A.
2166         assert!(nodes[1].node.claim_funds(payment_preimage_2));
2167         check_added_monitors!(nodes[1], 1);
2168         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2169
2170         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2171         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2172         check_added_monitors!(nodes[0], 1);
2173         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2174         expect_payment_sent!(nodes[0], payment_preimage_1);
2175
2176         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2177         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2178         check_added_monitors!(nodes[1], 1);
2179         // B is already AwaitingRAA, so cant generate a CS here
2180         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2181
2182         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2183         check_added_monitors!(nodes[1], 1);
2184         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2185
2186         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2187         check_added_monitors!(nodes[0], 1);
2188         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2189
2190         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2191         check_added_monitors!(nodes[1], 1);
2192         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2193
2194         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2195         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2196         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2197         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2198         // on-chain as necessary).
2199         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2200         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2201         check_added_monitors!(nodes[0], 1);
2202         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2203         expect_payment_sent!(nodes[0], payment_preimage_2);
2204
2205         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2206         check_added_monitors!(nodes[1], 1);
2207         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2208
2209         expect_pending_htlcs_forwardable!(nodes[1]);
2210         expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
2211
2212         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2213         // resolve the second HTLC from A's point of view.
2214         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2215         check_added_monitors!(nodes[0], 1);
2216         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2217
2218         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2219         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2220         let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
2221         let send_2 = {
2222                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2223                 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();
2224                 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
2225                 check_added_monitors!(nodes[1], 1);
2226                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2227                 assert_eq!(events.len(), 1);
2228                 SendEvent::from_event(events.remove(0))
2229         };
2230
2231         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2232         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2233         check_added_monitors!(nodes[0], 1);
2234         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2235
2236         // Now just resolve all the outstanding messages/HTLCs for completeness...
2237
2238         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2239         check_added_monitors!(nodes[1], 1);
2240         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2241
2242         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2243         check_added_monitors!(nodes[1], 1);
2244
2245         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2246         check_added_monitors!(nodes[0], 1);
2247         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2248
2249         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2250         check_added_monitors!(nodes[1], 1);
2251         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2252
2253         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2254         check_added_monitors!(nodes[0], 1);
2255
2256         expect_pending_htlcs_forwardable!(nodes[0]);
2257         expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2258
2259         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2260         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2261 }
2262
2263 #[test]
2264 fn channel_monitor_network_test() {
2265         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2266         // tests that ChannelMonitor is able to recover from various states.
2267         let chanmon_cfgs = create_chanmon_cfgs(5);
2268         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2269         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2270         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2271
2272         // Create some initial channels
2273         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2274         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2275         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2276         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2277
2278         // Make sure all nodes are at the same starting height
2279         connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2280         connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2281         connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2282         connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2283         connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2284
2285         // Rebalance the network a bit by relaying one payment through all the channels...
2286         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2287         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2288         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2289         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2290
2291         // Simple case with no pending HTLCs:
2292         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2293         check_added_monitors!(nodes[1], 1);
2294         check_closed_broadcast!(nodes[1], false);
2295         {
2296                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2297                 assert_eq!(node_txn.len(), 1);
2298                 mine_transaction(&nodes[0], &node_txn[0]);
2299                 check_added_monitors!(nodes[0], 1);
2300                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2301         }
2302         check_closed_broadcast!(nodes[0], true);
2303         assert_eq!(nodes[0].node.list_channels().len(), 0);
2304         assert_eq!(nodes[1].node.list_channels().len(), 1);
2305
2306         // One pending HTLC is discarded by the force-close:
2307         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2308
2309         // Simple case of one pending HTLC to HTLC-Timeout
2310         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2311         check_closed_broadcast!(nodes[1], false);
2312         check_added_monitors!(nodes[1], 1);
2313         {
2314                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2315                 mine_transaction(&nodes[2], &node_txn[0]);
2316                 check_added_monitors!(nodes[2], 1);
2317                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2318         }
2319         check_closed_broadcast!(nodes[2], true);
2320         assert_eq!(nodes[1].node.list_channels().len(), 0);
2321         assert_eq!(nodes[2].node.list_channels().len(), 1);
2322
2323         macro_rules! claim_funds {
2324                 ($node: expr, $prev_node: expr, $preimage: expr) => {
2325                         {
2326                                 assert!($node.node.claim_funds($preimage));
2327                                 check_added_monitors!($node, 1);
2328
2329                                 let events = $node.node.get_and_clear_pending_msg_events();
2330                                 assert_eq!(events.len(), 1);
2331                                 match events[0] {
2332                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2333                                                 assert!(update_add_htlcs.is_empty());
2334                                                 assert!(update_fail_htlcs.is_empty());
2335                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2336                                         },
2337                                         _ => panic!("Unexpected event"),
2338                                 };
2339                         }
2340                 }
2341         }
2342
2343         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2344         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2345         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2346         check_added_monitors!(nodes[2], 1);
2347         check_closed_broadcast!(nodes[2], false);
2348         let node2_commitment_txid;
2349         {
2350                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2351                 node2_commitment_txid = node_txn[0].txid();
2352
2353                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2354                 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2355                 mine_transaction(&nodes[3], &node_txn[0]);
2356                 check_added_monitors!(nodes[3], 1);
2357                 check_preimage_claim(&nodes[3], &node_txn);
2358         }
2359         check_closed_broadcast!(nodes[3], true);
2360         assert_eq!(nodes[2].node.list_channels().len(), 0);
2361         assert_eq!(nodes[3].node.list_channels().len(), 1);
2362
2363         // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2364         // confusing us in the following tests.
2365         let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2366
2367         // One pending HTLC to time out:
2368         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2369         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2370         // buffer space).
2371
2372         let (close_chan_update_1, close_chan_update_2) = {
2373                 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2374                 let events = nodes[3].node.get_and_clear_pending_msg_events();
2375                 assert_eq!(events.len(), 2);
2376                 let close_chan_update_1 = match events[0] {
2377                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2378                                 msg.clone()
2379                         },
2380                         _ => panic!("Unexpected event"),
2381                 };
2382                 match events[1] {
2383                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2384                                 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2385                         },
2386                         _ => panic!("Unexpected event"),
2387                 }
2388                 check_added_monitors!(nodes[3], 1);
2389
2390                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2391                 {
2392                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2393                         node_txn.retain(|tx| {
2394                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2395                                         false
2396                                 } else { true }
2397                         });
2398                 }
2399
2400                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2401
2402                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2403                 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2404
2405                 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2406                 let events = nodes[4].node.get_and_clear_pending_msg_events();
2407                 assert_eq!(events.len(), 2);
2408                 let close_chan_update_2 = match events[0] {
2409                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2410                                 msg.clone()
2411                         },
2412                         _ => panic!("Unexpected event"),
2413                 };
2414                 match events[1] {
2415                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2416                                 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2417                         },
2418                         _ => panic!("Unexpected event"),
2419                 }
2420                 check_added_monitors!(nodes[4], 1);
2421                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2422
2423                 mine_transaction(&nodes[4], &node_txn[0]);
2424                 check_preimage_claim(&nodes[4], &node_txn);
2425                 (close_chan_update_1, close_chan_update_2)
2426         };
2427         nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2428         nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2429         assert_eq!(nodes[3].node.list_channels().len(), 0);
2430         assert_eq!(nodes[4].node.list_channels().len(), 0);
2431
2432         nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2433 }
2434
2435 #[test]
2436 fn test_justice_tx() {
2437         // Test justice txn built on revoked HTLC-Success tx, against both sides
2438         let mut alice_config = UserConfig::default();
2439         alice_config.channel_options.announced_channel = true;
2440         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2441         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2442         let mut bob_config = UserConfig::default();
2443         bob_config.channel_options.announced_channel = true;
2444         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2445         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2446         let user_cfgs = [Some(alice_config), Some(bob_config)];
2447         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2448         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2449         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2450         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2451         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2452         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2453         // Create some new channels:
2454         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2455
2456         // A pending HTLC which will be revoked:
2457         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2458         // Get the will-be-revoked local txn from nodes[0]
2459         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2460         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2461         assert_eq!(revoked_local_txn[0].input.len(), 1);
2462         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2463         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2464         assert_eq!(revoked_local_txn[1].input.len(), 1);
2465         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2466         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2467         // Revoke the old state
2468         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2469
2470         {
2471                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2472                 {
2473                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2474                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2475                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2476
2477                         check_spends!(node_txn[0], revoked_local_txn[0]);
2478                         node_txn.swap_remove(0);
2479                         node_txn.truncate(1);
2480                 }
2481                 check_added_monitors!(nodes[1], 1);
2482                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2483
2484                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2485                 // Verify broadcast of revoked HTLC-timeout
2486                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2487                 check_added_monitors!(nodes[0], 1);
2488                 // Broadcast revoked HTLC-timeout on node 1
2489                 mine_transaction(&nodes[1], &node_txn[1]);
2490                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2491         }
2492         get_announce_close_broadcast_events(&nodes, 0, 1);
2493
2494         assert_eq!(nodes[0].node.list_channels().len(), 0);
2495         assert_eq!(nodes[1].node.list_channels().len(), 0);
2496
2497         // We test justice_tx build by A on B's revoked HTLC-Success tx
2498         // Create some new channels:
2499         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2500         {
2501                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2502                 node_txn.clear();
2503         }
2504
2505         // A pending HTLC which will be revoked:
2506         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2507         // Get the will-be-revoked local txn from B
2508         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2509         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2510         assert_eq!(revoked_local_txn[0].input.len(), 1);
2511         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2512         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2513         // Revoke the old state
2514         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2515         {
2516                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2517                 {
2518                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2519                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2520                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2521
2522                         check_spends!(node_txn[0], revoked_local_txn[0]);
2523                         node_txn.swap_remove(0);
2524                 }
2525                 check_added_monitors!(nodes[0], 1);
2526                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2527
2528                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2529                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2530                 check_added_monitors!(nodes[1], 1);
2531                 mine_transaction(&nodes[0], &node_txn[1]);
2532                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2533         }
2534         get_announce_close_broadcast_events(&nodes, 0, 1);
2535         assert_eq!(nodes[0].node.list_channels().len(), 0);
2536         assert_eq!(nodes[1].node.list_channels().len(), 0);
2537 }
2538
2539 #[test]
2540 fn revoked_output_claim() {
2541         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2542         // transaction is broadcast by its counterparty
2543         let chanmon_cfgs = create_chanmon_cfgs(2);
2544         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2545         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2546         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2547         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2548         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2549         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2550         assert_eq!(revoked_local_txn.len(), 1);
2551         // Only output is the full channel value back to nodes[0]:
2552         assert_eq!(revoked_local_txn[0].output.len(), 1);
2553         // Send a payment through, updating everyone's latest commitment txn
2554         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2555
2556         // Inform nodes[1] that nodes[0] broadcast a stale tx
2557         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2558         check_added_monitors!(nodes[1], 1);
2559         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2560         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2561
2562         check_spends!(node_txn[0], revoked_local_txn[0]);
2563         check_spends!(node_txn[1], chan_1.3);
2564
2565         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2566         mine_transaction(&nodes[0], &revoked_local_txn[0]);
2567         get_announce_close_broadcast_events(&nodes, 0, 1);
2568         check_added_monitors!(nodes[0], 1)
2569 }
2570
2571 #[test]
2572 fn claim_htlc_outputs_shared_tx() {
2573         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2574         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2575         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2576         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2577         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2578         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2579
2580         // Create some new channel:
2581         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2582
2583         // Rebalance the network to generate htlc in the two directions
2584         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2585         // 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
2586         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2587         let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2588
2589         // Get the will-be-revoked local txn from node[0]
2590         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2591         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2592         assert_eq!(revoked_local_txn[0].input.len(), 1);
2593         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2594         assert_eq!(revoked_local_txn[1].input.len(), 1);
2595         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2596         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2597         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2598
2599         //Revoke the old state
2600         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2601
2602         {
2603                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2604                 check_added_monitors!(nodes[0], 1);
2605                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2606                 check_added_monitors!(nodes[1], 1);
2607                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2608                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2609
2610                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2611                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2612
2613                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2614                 check_spends!(node_txn[0], revoked_local_txn[0]);
2615
2616                 let mut witness_lens = BTreeSet::new();
2617                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2618                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2619                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2620                 assert_eq!(witness_lens.len(), 3);
2621                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2622                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2623                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2624
2625                 // Next nodes[1] broadcasts its current local tx state:
2626                 assert_eq!(node_txn[1].input.len(), 1);
2627                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2628
2629                 assert_eq!(node_txn[2].input.len(), 1);
2630                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2631                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2632                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2633                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2634                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2635         }
2636         get_announce_close_broadcast_events(&nodes, 0, 1);
2637         assert_eq!(nodes[0].node.list_channels().len(), 0);
2638         assert_eq!(nodes[1].node.list_channels().len(), 0);
2639 }
2640
2641 #[test]
2642 fn claim_htlc_outputs_single_tx() {
2643         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2644         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2645         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2646         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2647         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2648         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2649
2650         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2651
2652         // Rebalance the network to generate htlc in the two directions
2653         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2654         // 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
2655         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2656         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2657         let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2658
2659         // Get the will-be-revoked local txn from node[0]
2660         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2661
2662         //Revoke the old state
2663         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2664
2665         {
2666                 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2667                 check_added_monitors!(nodes[0], 1);
2668                 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2669                 check_added_monitors!(nodes[1], 1);
2670                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2671
2672                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2673                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2674
2675                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2676                 assert_eq!(node_txn.len(), 9);
2677                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2678                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2679                 // 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)
2680                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2681
2682                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2683                 assert_eq!(node_txn[0].input.len(), 1);
2684                 check_spends!(node_txn[0], chan_1.3);
2685                 assert_eq!(node_txn[1].input.len(), 1);
2686                 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2687                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2688                 check_spends!(node_txn[1], node_txn[0]);
2689
2690                 // Justice transactions are indices 1-2-4
2691                 assert_eq!(node_txn[2].input.len(), 1);
2692                 assert_eq!(node_txn[3].input.len(), 1);
2693                 assert_eq!(node_txn[4].input.len(), 1);
2694
2695                 check_spends!(node_txn[2], revoked_local_txn[0]);
2696                 check_spends!(node_txn[3], revoked_local_txn[0]);
2697                 check_spends!(node_txn[4], revoked_local_txn[0]);
2698
2699                 let mut witness_lens = BTreeSet::new();
2700                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2701                 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2702                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2703                 assert_eq!(witness_lens.len(), 3);
2704                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2705                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2706                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2707         }
2708         get_announce_close_broadcast_events(&nodes, 0, 1);
2709         assert_eq!(nodes[0].node.list_channels().len(), 0);
2710         assert_eq!(nodes[1].node.list_channels().len(), 0);
2711 }
2712
2713 #[test]
2714 fn test_htlc_on_chain_success() {
2715         // Test that in case of a unilateral close onchain, we detect the state of output and pass
2716         // the preimage backward accordingly. So here we test that ChannelManager is
2717         // broadcasting the right event to other nodes in payment path.
2718         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2719         // A --------------------> B ----------------------> C (preimage)
2720         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2721         // commitment transaction was broadcast.
2722         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2723         // towards B.
2724         // B should be able to claim via preimage if A then broadcasts its local tx.
2725         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2726         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2727         // PaymentSent event).
2728
2729         let chanmon_cfgs = create_chanmon_cfgs(3);
2730         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2731         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2732         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2733
2734         // Create some initial channels
2735         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2736         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2737
2738         // Rebalance the network a bit by relaying one payment through all the channels...
2739         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2740         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2741
2742         let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2743         let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2744
2745         // Broadcast legit commitment tx from C on B's chain
2746         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2747         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2748         assert_eq!(commitment_tx.len(), 1);
2749         check_spends!(commitment_tx[0], chan_2.3);
2750         nodes[2].node.claim_funds(our_payment_preimage);
2751         nodes[2].node.claim_funds(our_payment_preimage_2);
2752         check_added_monitors!(nodes[2], 2);
2753         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2754         assert!(updates.update_add_htlcs.is_empty());
2755         assert!(updates.update_fail_htlcs.is_empty());
2756         assert!(updates.update_fail_malformed_htlcs.is_empty());
2757         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2758
2759         mine_transaction(&nodes[2], &commitment_tx[0]);
2760         check_closed_broadcast!(nodes[2], true);
2761         check_added_monitors!(nodes[2], 1);
2762         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)
2763         assert_eq!(node_txn.len(), 5);
2764         assert_eq!(node_txn[0], node_txn[3]);
2765         assert_eq!(node_txn[1], node_txn[4]);
2766         assert_eq!(node_txn[2], commitment_tx[0]);
2767         check_spends!(node_txn[0], commitment_tx[0]);
2768         check_spends!(node_txn[1], commitment_tx[0]);
2769         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2770         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2771         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2772         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2773         assert_eq!(node_txn[0].lock_time, 0);
2774         assert_eq!(node_txn[1].lock_time, 0);
2775
2776         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2777         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2778         connect_block(&nodes[1], &Block { header, txdata: node_txn});
2779         {
2780                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2781                 assert_eq!(added_monitors.len(), 1);
2782                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2783                 added_monitors.clear();
2784         }
2785         let events = nodes[1].node.get_and_clear_pending_msg_events();
2786         {
2787                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2788                 assert_eq!(added_monitors.len(), 2);
2789                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2790                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2791                 added_monitors.clear();
2792         }
2793         assert_eq!(events.len(), 3);
2794         match events[0] {
2795                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2796                 _ => panic!("Unexpected event"),
2797         }
2798         match events[1] {
2799                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2800                 _ => panic!("Unexpected event"),
2801         }
2802
2803         match events[2] {
2804                 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, .. } } => {
2805                         assert!(update_add_htlcs.is_empty());
2806                         assert!(update_fail_htlcs.is_empty());
2807                         assert_eq!(update_fulfill_htlcs.len(), 1);
2808                         assert!(update_fail_malformed_htlcs.is_empty());
2809                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2810                 },
2811                 _ => panic!("Unexpected event"),
2812         };
2813         macro_rules! check_tx_local_broadcast {
2814                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2815                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2816                         assert_eq!(node_txn.len(), 5);
2817                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2818                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2819                         check_spends!(node_txn[0], $commitment_tx);
2820                         check_spends!(node_txn[1], $commitment_tx);
2821                         assert_ne!(node_txn[0].lock_time, 0);
2822                         assert_ne!(node_txn[1].lock_time, 0);
2823                         if $htlc_offered {
2824                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2825                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2826                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2827                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2828                         } else {
2829                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2830                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2831                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2832                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2833                         }
2834                         check_spends!(node_txn[2], $chan_tx);
2835                         check_spends!(node_txn[3], node_txn[2]);
2836                         check_spends!(node_txn[4], node_txn[2]);
2837                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2838                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2839                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2840                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2841                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2842                         assert_ne!(node_txn[3].lock_time, 0);
2843                         assert_ne!(node_txn[4].lock_time, 0);
2844                         node_txn.clear();
2845                 } }
2846         }
2847         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2848         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2849         // timeout-claim of the output that nodes[2] just claimed via success.
2850         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2851
2852         // Broadcast legit commitment tx from A on B's chain
2853         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2854         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2855         check_spends!(commitment_tx[0], chan_1.3);
2856         mine_transaction(&nodes[1], &commitment_tx[0]);
2857         check_closed_broadcast!(nodes[1], true);
2858         check_added_monitors!(nodes[1], 1);
2859         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2860         assert_eq!(node_txn.len(), 4);
2861         check_spends!(node_txn[0], commitment_tx[0]);
2862         assert_eq!(node_txn[0].input.len(), 2);
2863         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2864         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2865         assert_eq!(node_txn[0].lock_time, 0);
2866         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2867         check_spends!(node_txn[1], chan_1.3);
2868         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2869         check_spends!(node_txn[2], node_txn[1]);
2870         check_spends!(node_txn[3], node_txn[1]);
2871         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2872         // we already checked the same situation with A.
2873
2874         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2875         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2876         connect_block(&nodes[0], &Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] });
2877         check_closed_broadcast!(nodes[0], true);
2878         check_added_monitors!(nodes[0], 1);
2879         let events = nodes[0].node.get_and_clear_pending_events();
2880         assert_eq!(events.len(), 2);
2881         let mut first_claimed = false;
2882         for event in events {
2883                 match event {
2884                         Event::PaymentSent { payment_preimage } => {
2885                                 if payment_preimage == our_payment_preimage {
2886                                         assert!(!first_claimed);
2887                                         first_claimed = true;
2888                                 } else {
2889                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2890                                 }
2891                         },
2892                         _ => panic!("Unexpected event"),
2893                 }
2894         }
2895         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2896 }
2897
2898 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2899         // Test that in case of a unilateral close onchain, we detect the state of output and
2900         // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2901         // broadcasting the right event to other nodes in payment path.
2902         // A ------------------> B ----------------------> C (timeout)
2903         //    B's commitment tx                 C's commitment tx
2904         //            \                                  \
2905         //         B's HTLC timeout tx               B's timeout tx
2906
2907         let chanmon_cfgs = create_chanmon_cfgs(3);
2908         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2909         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2910         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2911         *nodes[0].connect_style.borrow_mut() = connect_style;
2912         *nodes[1].connect_style.borrow_mut() = connect_style;
2913         *nodes[2].connect_style.borrow_mut() = connect_style;
2914
2915         // Create some intial channels
2916         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2917         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2918
2919         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2920         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2921         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2922
2923         let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2924
2925         // Broadcast legit commitment tx from C on B's chain
2926         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2927         check_spends!(commitment_tx[0], chan_2.3);
2928         nodes[2].node.fail_htlc_backwards(&payment_hash);
2929         check_added_monitors!(nodes[2], 0);
2930         expect_pending_htlcs_forwardable!(nodes[2]);
2931         check_added_monitors!(nodes[2], 1);
2932
2933         let events = nodes[2].node.get_and_clear_pending_msg_events();
2934         assert_eq!(events.len(), 1);
2935         match events[0] {
2936                 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, .. } } => {
2937                         assert!(update_add_htlcs.is_empty());
2938                         assert!(!update_fail_htlcs.is_empty());
2939                         assert!(update_fulfill_htlcs.is_empty());
2940                         assert!(update_fail_malformed_htlcs.is_empty());
2941                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2942                 },
2943                 _ => panic!("Unexpected event"),
2944         };
2945         mine_transaction(&nodes[2], &commitment_tx[0]);
2946         check_closed_broadcast!(nodes[2], true);
2947         check_added_monitors!(nodes[2], 1);
2948         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2949         assert_eq!(node_txn.len(), 1);
2950         check_spends!(node_txn[0], chan_2.3);
2951         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2952
2953         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2954         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2955         connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2956         mine_transaction(&nodes[1], &commitment_tx[0]);
2957         let timeout_tx;
2958         {
2959                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2960                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2961                 assert_eq!(node_txn[0], node_txn[3]);
2962                 assert_eq!(node_txn[1], node_txn[4]);
2963
2964                 check_spends!(node_txn[2], commitment_tx[0]);
2965                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2966
2967                 check_spends!(node_txn[0], chan_2.3);
2968                 check_spends!(node_txn[1], node_txn[0]);
2969                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2970                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2971
2972                 timeout_tx = node_txn[2].clone();
2973                 node_txn.clear();
2974         }
2975
2976         mine_transaction(&nodes[1], &timeout_tx);
2977         check_added_monitors!(nodes[1], 1);
2978         check_closed_broadcast!(nodes[1], true);
2979         {
2980                 // B will rebroadcast a fee-bumped timeout transaction here.
2981                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2982                 assert_eq!(node_txn.len(), 1);
2983                 check_spends!(node_txn[0], commitment_tx[0]);
2984         }
2985
2986         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2987         {
2988                 // B will rebroadcast its own holder commitment transaction here...just because
2989                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2990                 assert_eq!(node_txn.len(), 1);
2991                 check_spends!(node_txn[0], chan_2.3);
2992         }
2993
2994         expect_pending_htlcs_forwardable!(nodes[1]);
2995         check_added_monitors!(nodes[1], 1);
2996         let events = nodes[1].node.get_and_clear_pending_msg_events();
2997         assert_eq!(events.len(), 1);
2998         match events[0] {
2999                 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, .. } } => {
3000                         assert!(update_add_htlcs.is_empty());
3001                         assert!(!update_fail_htlcs.is_empty());
3002                         assert!(update_fulfill_htlcs.is_empty());
3003                         assert!(update_fail_malformed_htlcs.is_empty());
3004                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3005                 },
3006                 _ => panic!("Unexpected event"),
3007         };
3008
3009         // Broadcast legit commitment tx from B on A's chain
3010         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3011         check_spends!(commitment_tx[0], chan_1.3);
3012
3013         mine_transaction(&nodes[0], &commitment_tx[0]);
3014
3015         check_closed_broadcast!(nodes[0], true);
3016         check_added_monitors!(nodes[0], 1);
3017         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
3018         assert_eq!(node_txn.len(), 3);
3019         check_spends!(node_txn[0], commitment_tx[0]);
3020         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3021         check_spends!(node_txn[1], chan_1.3);
3022         check_spends!(node_txn[2], node_txn[1]);
3023         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
3024         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3025 }
3026
3027 #[test]
3028 fn test_htlc_on_chain_timeout() {
3029         do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
3030         do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
3031         do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
3032 }
3033
3034 #[test]
3035 fn test_simple_commitment_revoked_fail_backward() {
3036         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3037         // and fail backward accordingly.
3038
3039         let chanmon_cfgs = create_chanmon_cfgs(3);
3040         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3041         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3042         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3043
3044         // Create some initial channels
3045         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3046         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3047
3048         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3049         // Get the will-be-revoked local txn from nodes[2]
3050         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3051         // Revoke the old state
3052         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3053
3054         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3055
3056         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3057         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3058         check_added_monitors!(nodes[1], 1);
3059         check_closed_broadcast!(nodes[1], true);
3060
3061         expect_pending_htlcs_forwardable!(nodes[1]);
3062         check_added_monitors!(nodes[1], 1);
3063         let events = nodes[1].node.get_and_clear_pending_msg_events();
3064         assert_eq!(events.len(), 1);
3065         match events[0] {
3066                 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, .. } } => {
3067                         assert!(update_add_htlcs.is_empty());
3068                         assert_eq!(update_fail_htlcs.len(), 1);
3069                         assert!(update_fulfill_htlcs.is_empty());
3070                         assert!(update_fail_malformed_htlcs.is_empty());
3071                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3072
3073                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3074                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3075
3076                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3077                         assert_eq!(events.len(), 1);
3078                         match events[0] {
3079                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3080                                 _ => panic!("Unexpected event"),
3081                         }
3082                         expect_payment_failed!(nodes[0], payment_hash, false);
3083                 },
3084                 _ => panic!("Unexpected event"),
3085         }
3086 }
3087
3088 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3089         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3090         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3091         // commitment transaction anymore.
3092         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3093         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3094         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3095         // technically disallowed and we should probably handle it reasonably.
3096         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3097         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3098         // transactions:
3099         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3100         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3101         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3102         //   and once they revoke the previous commitment transaction (allowing us to send a new
3103         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3104         let chanmon_cfgs = create_chanmon_cfgs(3);
3105         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3106         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3107         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3108
3109         // Create some initial channels
3110         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3111         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3112
3113         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 });
3114         // Get the will-be-revoked local txn from nodes[2]
3115         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3116         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3117         // Revoke the old state
3118         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3119
3120         let value = if use_dust {
3121                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3122                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3123                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3124         } else { 3000000 };
3125
3126         let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3127         let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3128         let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3129
3130         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
3131         expect_pending_htlcs_forwardable!(nodes[2]);
3132         check_added_monitors!(nodes[2], 1);
3133         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3134         assert!(updates.update_add_htlcs.is_empty());
3135         assert!(updates.update_fulfill_htlcs.is_empty());
3136         assert!(updates.update_fail_malformed_htlcs.is_empty());
3137         assert_eq!(updates.update_fail_htlcs.len(), 1);
3138         assert!(updates.update_fee.is_none());
3139         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3140         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3141         // Drop the last RAA from 3 -> 2
3142
3143         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
3144         expect_pending_htlcs_forwardable!(nodes[2]);
3145         check_added_monitors!(nodes[2], 1);
3146         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3147         assert!(updates.update_add_htlcs.is_empty());
3148         assert!(updates.update_fulfill_htlcs.is_empty());
3149         assert!(updates.update_fail_malformed_htlcs.is_empty());
3150         assert_eq!(updates.update_fail_htlcs.len(), 1);
3151         assert!(updates.update_fee.is_none());
3152         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3153         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3154         check_added_monitors!(nodes[1], 1);
3155         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3156         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3157         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3158         check_added_monitors!(nodes[2], 1);
3159
3160         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
3161         expect_pending_htlcs_forwardable!(nodes[2]);
3162         check_added_monitors!(nodes[2], 1);
3163         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3164         assert!(updates.update_add_htlcs.is_empty());
3165         assert!(updates.update_fulfill_htlcs.is_empty());
3166         assert!(updates.update_fail_malformed_htlcs.is_empty());
3167         assert_eq!(updates.update_fail_htlcs.len(), 1);
3168         assert!(updates.update_fee.is_none());
3169         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3170         // At this point first_payment_hash has dropped out of the latest two commitment
3171         // transactions that nodes[1] is tracking...
3172         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3173         check_added_monitors!(nodes[1], 1);
3174         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3175         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3176         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3177         check_added_monitors!(nodes[2], 1);
3178
3179         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3180         // on nodes[2]'s RAA.
3181         let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3182         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3183         let logger = test_utils::TestLogger::new();
3184         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();
3185         nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
3186         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3187         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3188         check_added_monitors!(nodes[1], 0);
3189
3190         if deliver_bs_raa {
3191                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3192                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3193                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3194                 check_added_monitors!(nodes[1], 1);
3195                 let events = nodes[1].node.get_and_clear_pending_events();
3196                 assert_eq!(events.len(), 1);
3197                 match events[0] {
3198                         Event::PendingHTLCsForwardable { .. } => { },
3199                         _ => panic!("Unexpected event"),
3200                 };
3201                 // Deliberately don't process the pending fail-back so they all fail back at once after
3202                 // block connection just like the !deliver_bs_raa case
3203         }
3204
3205         let mut failed_htlcs = HashSet::new();
3206         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3207
3208         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3209         check_added_monitors!(nodes[1], 1);
3210         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3211
3212         let events = nodes[1].node.get_and_clear_pending_events();
3213         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3214         match events[0] {
3215                 Event::PaymentFailed { ref payment_hash, .. } => {
3216                         assert_eq!(*payment_hash, fourth_payment_hash);
3217                 },
3218                 _ => panic!("Unexpected event"),
3219         }
3220         if !deliver_bs_raa {
3221                 match events[1] {
3222                         Event::PendingHTLCsForwardable { .. } => { },
3223                         _ => panic!("Unexpected event"),
3224                 };
3225         }
3226         nodes[1].node.process_pending_htlc_forwards();
3227         check_added_monitors!(nodes[1], 1);
3228
3229         let events = nodes[1].node.get_and_clear_pending_msg_events();
3230         assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3231         match events[if deliver_bs_raa { 1 } else { 0 }] {
3232                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3233                 _ => panic!("Unexpected event"),
3234         }
3235         match events[if deliver_bs_raa { 2 } else { 1 }] {
3236                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3237                         assert_eq!(channel_id, chan_2.2);
3238                         assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3239                 },
3240                 _ => panic!("Unexpected event"),
3241         }
3242         if deliver_bs_raa {
3243                 match events[0] {
3244                         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, .. } } => {
3245                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3246                                 assert_eq!(update_add_htlcs.len(), 1);
3247                                 assert!(update_fulfill_htlcs.is_empty());
3248                                 assert!(update_fail_htlcs.is_empty());
3249                                 assert!(update_fail_malformed_htlcs.is_empty());
3250                         },
3251                         _ => panic!("Unexpected event"),
3252                 }
3253         }
3254         match events[if deliver_bs_raa { 3 } else { 2 }] {
3255                 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, .. } } => {
3256                         assert!(update_add_htlcs.is_empty());
3257                         assert_eq!(update_fail_htlcs.len(), 3);
3258                         assert!(update_fulfill_htlcs.is_empty());
3259                         assert!(update_fail_malformed_htlcs.is_empty());
3260                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3261
3262                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3263                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3264                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3265
3266                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3267
3268                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3269                         // If we delivered B's RAA we got an unknown preimage error, not something
3270                         // that we should update our routing table for.
3271                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3272                         for event in events {
3273                                 match event {
3274                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3275                                         _ => panic!("Unexpected event"),
3276                                 }
3277                         }
3278                         let events = nodes[0].node.get_and_clear_pending_events();
3279                         assert_eq!(events.len(), 3);
3280                         match events[0] {
3281                                 Event::PaymentFailed { ref payment_hash, .. } => {
3282                                         assert!(failed_htlcs.insert(payment_hash.0));
3283                                 },
3284                                 _ => panic!("Unexpected event"),
3285                         }
3286                         match events[1] {
3287                                 Event::PaymentFailed { ref payment_hash, .. } => {
3288                                         assert!(failed_htlcs.insert(payment_hash.0));
3289                                 },
3290                                 _ => panic!("Unexpected event"),
3291                         }
3292                         match events[2] {
3293                                 Event::PaymentFailed { ref payment_hash, .. } => {
3294                                         assert!(failed_htlcs.insert(payment_hash.0));
3295                                 },
3296                                 _ => panic!("Unexpected event"),
3297                         }
3298                 },
3299                 _ => panic!("Unexpected event"),
3300         }
3301
3302         assert!(failed_htlcs.contains(&first_payment_hash.0));
3303         assert!(failed_htlcs.contains(&second_payment_hash.0));
3304         assert!(failed_htlcs.contains(&third_payment_hash.0));
3305 }
3306
3307 #[test]
3308 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3309         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3310         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3311         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3312         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3313 }
3314
3315 #[test]
3316 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3317         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3318         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3319         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3320         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3321 }
3322
3323 #[test]
3324 fn fail_backward_pending_htlc_upon_channel_failure() {
3325         let chanmon_cfgs = create_chanmon_cfgs(2);
3326         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3327         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3328         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3329         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3330         let logger = test_utils::TestLogger::new();
3331
3332         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3333         {
3334                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3335                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3336                 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();
3337                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3338                 check_added_monitors!(nodes[0], 1);
3339
3340                 let payment_event = {
3341                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3342                         assert_eq!(events.len(), 1);
3343                         SendEvent::from_event(events.remove(0))
3344                 };
3345                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3346                 assert_eq!(payment_event.msgs.len(), 1);
3347         }
3348
3349         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3350         let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3351         {
3352                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3353                 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();
3354                 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3355                 check_added_monitors!(nodes[0], 0);
3356
3357                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3358         }
3359
3360         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3361         {
3362                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3363
3364                 let secp_ctx = Secp256k1::new();
3365                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3366                 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3367                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3368                 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();
3369                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height).unwrap();
3370                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3371                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3372
3373                 // Send a 0-msat update_add_htlc to fail the channel.
3374                 let update_add_htlc = msgs::UpdateAddHTLC {
3375                         channel_id: chan.2,
3376                         htlc_id: 0,
3377                         amount_msat: 0,
3378                         payment_hash,
3379                         cltv_expiry,
3380                         onion_routing_packet,
3381                 };
3382                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3383         }
3384
3385         // Check that Alice fails backward the pending HTLC from the second payment.
3386         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3387         check_closed_broadcast!(nodes[0], true);
3388         check_added_monitors!(nodes[0], 1);
3389 }
3390
3391 #[test]
3392 fn test_htlc_ignore_latest_remote_commitment() {
3393         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3394         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3395         let chanmon_cfgs = create_chanmon_cfgs(2);
3396         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3397         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3398         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3399         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3400
3401         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3402         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3403         check_closed_broadcast!(nodes[0], true);
3404         check_added_monitors!(nodes[0], 1);
3405
3406         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3407         assert_eq!(node_txn.len(), 2);
3408
3409         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3410         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3411         check_closed_broadcast!(nodes[1], true);
3412         check_added_monitors!(nodes[1], 1);
3413
3414         // Duplicate the connect_block call since this may happen due to other listeners
3415         // registering new transactions
3416         header.prev_blockhash = header.block_hash();
3417         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3418 }
3419
3420 #[test]
3421 fn test_force_close_fail_back() {
3422         // Check which HTLCs are failed-backwards on channel force-closure
3423         let chanmon_cfgs = create_chanmon_cfgs(3);
3424         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3425         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3426         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3427         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3428         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3429         let logger = test_utils::TestLogger::new();
3430
3431         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3432
3433         let mut payment_event = {
3434                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3435                 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();
3436                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3437                 check_added_monitors!(nodes[0], 1);
3438
3439                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3440                 assert_eq!(events.len(), 1);
3441                 SendEvent::from_event(events.remove(0))
3442         };
3443
3444         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3445         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3446
3447         expect_pending_htlcs_forwardable!(nodes[1]);
3448
3449         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3450         assert_eq!(events_2.len(), 1);
3451         payment_event = SendEvent::from_event(events_2.remove(0));
3452         assert_eq!(payment_event.msgs.len(), 1);
3453
3454         check_added_monitors!(nodes[1], 1);
3455         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3456         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3457         check_added_monitors!(nodes[2], 1);
3458         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3459
3460         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3461         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3462         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3463
3464         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3465         check_closed_broadcast!(nodes[2], true);
3466         check_added_monitors!(nodes[2], 1);
3467         let tx = {
3468                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3469                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3470                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3471                 // back to nodes[1] upon timeout otherwise.
3472                 assert_eq!(node_txn.len(), 1);
3473                 node_txn.remove(0)
3474         };
3475
3476         mine_transaction(&nodes[1], &tx);
3477
3478         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3479         check_closed_broadcast!(nodes[1], true);
3480         check_added_monitors!(nodes[1], 1);
3481
3482         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3483         {
3484                 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3485                 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3486                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3487         }
3488         mine_transaction(&nodes[2], &tx);
3489         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3490         assert_eq!(node_txn.len(), 1);
3491         assert_eq!(node_txn[0].input.len(), 1);
3492         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3493         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3494         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3495
3496         check_spends!(node_txn[0], tx);
3497 }
3498
3499 #[test]
3500 fn test_dup_events_on_peer_disconnect() {
3501         // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3502         // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3503         // as we used to generate the event immediately upon receipt of the payment preimage in the
3504         // update_fulfill_htlc message.
3505
3506         let chanmon_cfgs = create_chanmon_cfgs(2);
3507         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3508         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3509         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3510         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3511
3512         let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3513
3514         assert!(nodes[1].node.claim_funds(payment_preimage));
3515         check_added_monitors!(nodes[1], 1);
3516         let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3517         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3518         expect_payment_sent!(nodes[0], payment_preimage);
3519
3520         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3521         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3522
3523         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3524         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3525 }
3526
3527 #[test]
3528 fn test_simple_peer_disconnect() {
3529         // Test that we can reconnect when there are no lost messages
3530         let chanmon_cfgs = create_chanmon_cfgs(3);
3531         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3532         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3533         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3534         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3535         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3536
3537         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3538         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3539         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3540
3541         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3542         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3543         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3544         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3545
3546         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3547         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3548         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3549
3550         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3551         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3552         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3553         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3554
3555         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3556         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3557
3558         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3559         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3560
3561         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3562         {
3563                 let events = nodes[0].node.get_and_clear_pending_events();
3564                 assert_eq!(events.len(), 2);
3565                 match events[0] {
3566                         Event::PaymentSent { payment_preimage } => {
3567                                 assert_eq!(payment_preimage, payment_preimage_3);
3568                         },
3569                         _ => panic!("Unexpected event"),
3570                 }
3571                 match events[1] {
3572                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3573                                 assert_eq!(payment_hash, payment_hash_5);
3574                                 assert!(rejected_by_dest);
3575                         },
3576                         _ => panic!("Unexpected event"),
3577                 }
3578         }
3579
3580         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3581         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3582 }
3583
3584 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3585         // Test that we can reconnect when in-flight HTLC updates get dropped
3586         let chanmon_cfgs = create_chanmon_cfgs(2);
3587         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3588         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3589         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3590         if messages_delivered == 0 {
3591                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3592                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3593         } else {
3594                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3595         }
3596
3597         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3598
3599         let logger = test_utils::TestLogger::new();
3600         let payment_event = {
3601                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3602                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3603                         &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3604                         &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3605                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3606                 check_added_monitors!(nodes[0], 1);
3607
3608                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3609                 assert_eq!(events.len(), 1);
3610                 SendEvent::from_event(events.remove(0))
3611         };
3612         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3613
3614         if messages_delivered < 2 {
3615                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3616         } else {
3617                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3618                 if messages_delivered >= 3 {
3619                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3620                         check_added_monitors!(nodes[1], 1);
3621                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3622
3623                         if messages_delivered >= 4 {
3624                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3625                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3626                                 check_added_monitors!(nodes[0], 1);
3627
3628                                 if messages_delivered >= 5 {
3629                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3630                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3631                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3632                                         check_added_monitors!(nodes[0], 1);
3633
3634                                         if messages_delivered >= 6 {
3635                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3636                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3637                                                 check_added_monitors!(nodes[1], 1);
3638                                         }
3639                                 }
3640                         }
3641                 }
3642         }
3643
3644         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3645         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3646         if messages_delivered < 3 {
3647                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3648                 // received on either side, both sides will need to resend them.
3649                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3650         } else if messages_delivered == 3 {
3651                 // nodes[0] still wants its RAA + commitment_signed
3652                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3653         } else if messages_delivered == 4 {
3654                 // nodes[0] still wants its commitment_signed
3655                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3656         } else if messages_delivered == 5 {
3657                 // nodes[1] still wants its final RAA
3658                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3659         } else if messages_delivered == 6 {
3660                 // Everything was delivered...
3661                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3662         }
3663
3664         let events_1 = nodes[1].node.get_and_clear_pending_events();
3665         assert_eq!(events_1.len(), 1);
3666         match events_1[0] {
3667                 Event::PendingHTLCsForwardable { .. } => { },
3668                 _ => panic!("Unexpected event"),
3669         };
3670
3671         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3672         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3673         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3674
3675         nodes[1].node.process_pending_htlc_forwards();
3676
3677         let events_2 = nodes[1].node.get_and_clear_pending_events();
3678         assert_eq!(events_2.len(), 1);
3679         match events_2[0] {
3680                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
3681                         assert_eq!(payment_hash_1, *payment_hash);
3682                         assert!(payment_preimage.is_none());
3683                         assert_eq!(payment_secret_1, *payment_secret);
3684                         assert_eq!(amt, 1000000);
3685                 },
3686                 _ => panic!("Unexpected event"),
3687         }
3688
3689         nodes[1].node.claim_funds(payment_preimage_1);
3690         check_added_monitors!(nodes[1], 1);
3691
3692         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3693         assert_eq!(events_3.len(), 1);
3694         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3695                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3696                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3697                         assert!(updates.update_add_htlcs.is_empty());
3698                         assert!(updates.update_fail_htlcs.is_empty());
3699                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3700                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3701                         assert!(updates.update_fee.is_none());
3702                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3703                 },
3704                 _ => panic!("Unexpected event"),
3705         };
3706
3707         if messages_delivered >= 1 {
3708                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3709
3710                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3711                 assert_eq!(events_4.len(), 1);
3712                 match events_4[0] {
3713                         Event::PaymentSent { ref payment_preimage } => {
3714                                 assert_eq!(payment_preimage_1, *payment_preimage);
3715                         },
3716                         _ => panic!("Unexpected event"),
3717                 }
3718
3719                 if messages_delivered >= 2 {
3720                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3721                         check_added_monitors!(nodes[0], 1);
3722                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3723
3724                         if messages_delivered >= 3 {
3725                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3726                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3727                                 check_added_monitors!(nodes[1], 1);
3728
3729                                 if messages_delivered >= 4 {
3730                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3731                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3732                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3733                                         check_added_monitors!(nodes[1], 1);
3734
3735                                         if messages_delivered >= 5 {
3736                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3737                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3738                                                 check_added_monitors!(nodes[0], 1);
3739                                         }
3740                                 }
3741                         }
3742                 }
3743         }
3744
3745         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3746         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3747         if messages_delivered < 2 {
3748                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3749                 if messages_delivered < 1 {
3750                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3751                         assert_eq!(events_4.len(), 1);
3752                         match events_4[0] {
3753                                 Event::PaymentSent { ref payment_preimage } => {
3754                                         assert_eq!(payment_preimage_1, *payment_preimage);
3755                                 },
3756                                 _ => panic!("Unexpected event"),
3757                         }
3758                 } else {
3759                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3760                 }
3761         } else if messages_delivered == 2 {
3762                 // nodes[0] still wants its RAA + commitment_signed
3763                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3764         } else if messages_delivered == 3 {
3765                 // nodes[0] still wants its commitment_signed
3766                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3767         } else if messages_delivered == 4 {
3768                 // nodes[1] still wants its final RAA
3769                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3770         } else if messages_delivered == 5 {
3771                 // Everything was delivered...
3772                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3773         }
3774
3775         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3776         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3777         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3778
3779         // Channel should still work fine...
3780         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3781         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3782                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3783                 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3784         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3785         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3786 }
3787
3788 #[test]
3789 fn test_drop_messages_peer_disconnect_a() {
3790         do_test_drop_messages_peer_disconnect(0);
3791         do_test_drop_messages_peer_disconnect(1);
3792         do_test_drop_messages_peer_disconnect(2);
3793         do_test_drop_messages_peer_disconnect(3);
3794 }
3795
3796 #[test]
3797 fn test_drop_messages_peer_disconnect_b() {
3798         do_test_drop_messages_peer_disconnect(4);
3799         do_test_drop_messages_peer_disconnect(5);
3800         do_test_drop_messages_peer_disconnect(6);
3801 }
3802
3803 #[test]
3804 fn test_funding_peer_disconnect() {
3805         // Test that we can lock in our funding tx while disconnected
3806         let chanmon_cfgs = create_chanmon_cfgs(2);
3807         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3808         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3809         let persister: test_utils::TestPersister;
3810         let new_chain_monitor: test_utils::TestChainMonitor;
3811         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3812         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3813         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3814
3815         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3816         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3817
3818         confirm_transaction(&nodes[0], &tx);
3819         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3820         assert_eq!(events_1.len(), 1);
3821         match events_1[0] {
3822                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3823                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3824                 },
3825                 _ => panic!("Unexpected event"),
3826         }
3827
3828         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3829
3830         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3831         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3832
3833         confirm_transaction(&nodes[1], &tx);
3834         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3835         assert_eq!(events_2.len(), 2);
3836         let funding_locked = match events_2[0] {
3837                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3838                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3839                         msg.clone()
3840                 },
3841                 _ => panic!("Unexpected event"),
3842         };
3843         let bs_announcement_sigs = match events_2[1] {
3844                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3845                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3846                         msg.clone()
3847                 },
3848                 _ => panic!("Unexpected event"),
3849         };
3850
3851         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3852
3853         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3854         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3855         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3856         assert_eq!(events_3.len(), 2);
3857         let as_announcement_sigs = match events_3[0] {
3858                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3859                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3860                         msg.clone()
3861                 },
3862                 _ => panic!("Unexpected event"),
3863         };
3864         let (as_announcement, as_update) = match events_3[1] {
3865                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3866                         (msg.clone(), update_msg.clone())
3867                 },
3868                 _ => panic!("Unexpected event"),
3869         };
3870
3871         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3872         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3873         assert_eq!(events_4.len(), 1);
3874         let (_, bs_update) = match events_4[0] {
3875                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3876                         (msg.clone(), update_msg.clone())
3877                 },
3878                 _ => panic!("Unexpected event"),
3879         };
3880
3881         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3882         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3883         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3884
3885         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3886         let logger = test_utils::TestLogger::new();
3887         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();
3888         let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3889         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3890
3891         // Check that after deserialization and reconnection we can still generate an identical
3892         // channel_announcement from the cached signatures.
3893         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3894
3895         let nodes_0_serialized = nodes[0].node.encode();
3896         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3897         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3898
3899         persister = test_utils::TestPersister::new();
3900         let keys_manager = &chanmon_cfgs[0].keys_manager;
3901         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);
3902         nodes[0].chain_monitor = &new_chain_monitor;
3903         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3904         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3905                 &mut chan_0_monitor_read, keys_manager).unwrap();
3906         assert!(chan_0_monitor_read.is_empty());
3907
3908         let mut nodes_0_read = &nodes_0_serialized[..];
3909         let (_, nodes_0_deserialized_tmp) = {
3910                 let mut channel_monitors = HashMap::new();
3911                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3912                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3913                         default_config: UserConfig::default(),
3914                         keys_manager,
3915                         fee_estimator: node_cfgs[0].fee_estimator,
3916                         chain_monitor: nodes[0].chain_monitor,
3917                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3918                         logger: nodes[0].logger,
3919                         channel_monitors,
3920                 }).unwrap()
3921         };
3922         nodes_0_deserialized = nodes_0_deserialized_tmp;
3923         assert!(nodes_0_read.is_empty());
3924
3925         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
3926         nodes[0].node = &nodes_0_deserialized;
3927         check_added_monitors!(nodes[0], 1);
3928
3929         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3930
3931         // as_announcement should be re-generated exactly by broadcast_node_announcement.
3932         nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
3933         let msgs = nodes[0].node.get_and_clear_pending_msg_events();
3934         let mut found_announcement = false;
3935         for event in msgs.iter() {
3936                 match event {
3937                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
3938                                 if *msg == as_announcement { found_announcement = true; }
3939                         },
3940                         MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
3941                         _ => panic!("Unexpected event"),
3942                 }
3943         }
3944         assert!(found_announcement);
3945 }
3946
3947 #[test]
3948 fn test_drop_messages_peer_disconnect_dual_htlc() {
3949         // Test that we can handle reconnecting when both sides of a channel have pending
3950         // commitment_updates when we disconnect.
3951         let chanmon_cfgs = create_chanmon_cfgs(2);
3952         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3953         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3954         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3955         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3956         let logger = test_utils::TestLogger::new();
3957
3958         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3959
3960         // Now try to send a second payment which will fail to send
3961         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
3962         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3963         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();
3964         nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
3965         check_added_monitors!(nodes[0], 1);
3966
3967         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3968         assert_eq!(events_1.len(), 1);
3969         match events_1[0] {
3970                 MessageSendEvent::UpdateHTLCs { .. } => {},
3971                 _ => panic!("Unexpected event"),
3972         }
3973
3974         assert!(nodes[1].node.claim_funds(payment_preimage_1));
3975         check_added_monitors!(nodes[1], 1);
3976
3977         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3978         assert_eq!(events_2.len(), 1);
3979         match events_2[0] {
3980                 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 } } => {
3981                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3982                         assert!(update_add_htlcs.is_empty());
3983                         assert_eq!(update_fulfill_htlcs.len(), 1);
3984                         assert!(update_fail_htlcs.is_empty());
3985                         assert!(update_fail_malformed_htlcs.is_empty());
3986                         assert!(update_fee.is_none());
3987
3988                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3989                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3990                         assert_eq!(events_3.len(), 1);
3991                         match events_3[0] {
3992                                 Event::PaymentSent { ref payment_preimage } => {
3993                                         assert_eq!(*payment_preimage, payment_preimage_1);
3994                                 },
3995                                 _ => panic!("Unexpected event"),
3996                         }
3997
3998                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3999                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4000                         // No commitment_signed so get_event_msg's assert(len == 1) passes
4001                         check_added_monitors!(nodes[0], 1);
4002                 },
4003                 _ => panic!("Unexpected event"),
4004         }
4005
4006         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4007         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4008
4009         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4010         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4011         assert_eq!(reestablish_1.len(), 1);
4012         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4013         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4014         assert_eq!(reestablish_2.len(), 1);
4015
4016         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4017         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4018         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4019         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4020
4021         assert!(as_resp.0.is_none());
4022         assert!(bs_resp.0.is_none());
4023
4024         assert!(bs_resp.1.is_none());
4025         assert!(bs_resp.2.is_none());
4026
4027         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4028
4029         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
4030         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
4031         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4032         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4033         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
4034         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
4035         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
4036         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4037         // No commitment_signed so get_event_msg's assert(len == 1) passes
4038         check_added_monitors!(nodes[1], 1);
4039
4040         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
4041         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4042         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4043         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4044         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4045         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4046         assert!(bs_second_commitment_signed.update_fee.is_none());
4047         check_added_monitors!(nodes[1], 1);
4048
4049         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4050         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4051         assert!(as_commitment_signed.update_add_htlcs.is_empty());
4052         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4053         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4054         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4055         assert!(as_commitment_signed.update_fee.is_none());
4056         check_added_monitors!(nodes[0], 1);
4057
4058         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4059         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4060         // No commitment_signed so get_event_msg's assert(len == 1) passes
4061         check_added_monitors!(nodes[0], 1);
4062
4063         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4064         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4065         // No commitment_signed so get_event_msg's assert(len == 1) passes
4066         check_added_monitors!(nodes[1], 1);
4067
4068         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4069         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4070         check_added_monitors!(nodes[1], 1);
4071
4072         expect_pending_htlcs_forwardable!(nodes[1]);
4073
4074         let events_5 = nodes[1].node.get_and_clear_pending_events();
4075         assert_eq!(events_5.len(), 1);
4076         match events_5[0] {
4077                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt: _, user_payment_id: _ } => {
4078                         assert_eq!(payment_hash_2, *payment_hash);
4079                         assert!(payment_preimage.is_none());
4080                         assert_eq!(payment_secret_2, *payment_secret);
4081                 },
4082                 _ => panic!("Unexpected event"),
4083         }
4084
4085         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4086         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4087         check_added_monitors!(nodes[0], 1);
4088
4089         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4090 }
4091
4092 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4093         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4094         // to avoid our counterparty failing the channel.
4095         let chanmon_cfgs = create_chanmon_cfgs(2);
4096         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4097         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4098         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4099
4100         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4101         let logger = test_utils::TestLogger::new();
4102
4103         let our_payment_hash = if send_partial_mpp {
4104                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4105                 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();
4106                 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
4107                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4108                 // indicates there are more HTLCs coming.
4109                 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.
4110                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height).unwrap();
4111                 check_added_monitors!(nodes[0], 1);
4112                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4113                 assert_eq!(events.len(), 1);
4114                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4115                 // hop should *not* yet generate any PaymentReceived event(s).
4116                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, payment_secret, events.drain(..).next().unwrap(), false);
4117                 our_payment_hash
4118         } else {
4119                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4120         };
4121
4122         let mut block = Block {
4123                 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4124                 txdata: vec![],
4125         };
4126         connect_block(&nodes[0], &block);
4127         connect_block(&nodes[1], &block);
4128         let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
4129         for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
4130                 block.header.prev_blockhash = block.block_hash();
4131                 connect_block(&nodes[0], &block);
4132                 connect_block(&nodes[1], &block);
4133         }
4134
4135         expect_pending_htlcs_forwardable!(nodes[1]);
4136
4137         check_added_monitors!(nodes[1], 1);
4138         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4139         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4140         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4141         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4142         assert!(htlc_timeout_updates.update_fee.is_none());
4143
4144         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4145         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4146         // 100_000 msat as u64, followed by the height at which we failed back above
4147         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4148         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4149         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4150 }
4151
4152 #[test]
4153 fn test_htlc_timeout() {
4154         do_test_htlc_timeout(true);
4155         do_test_htlc_timeout(false);
4156 }
4157
4158 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4159         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4160         let chanmon_cfgs = create_chanmon_cfgs(3);
4161         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4162         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4163         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4164         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4165         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4166
4167         // Make sure all nodes are at the same starting height
4168         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4169         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4170         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4171
4172         let logger = test_utils::TestLogger::new();
4173
4174         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4175         let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4176         {
4177                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4178                 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();
4179                 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4180         }
4181         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4182         check_added_monitors!(nodes[1], 1);
4183
4184         // Now attempt to route a second payment, which should be placed in the holding cell
4185         let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4186         if forwarded_htlc {
4187                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4188                 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();
4189                 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4190                 check_added_monitors!(nodes[0], 1);
4191                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4192                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4193                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4194                 expect_pending_htlcs_forwardable!(nodes[1]);
4195                 check_added_monitors!(nodes[1], 0);
4196         } else {
4197                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4198                 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();
4199                 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4200                 check_added_monitors!(nodes[1], 0);
4201         }
4202
4203         connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4204         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4205         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4206         connect_blocks(&nodes[1], 1);
4207
4208         if forwarded_htlc {
4209                 expect_pending_htlcs_forwardable!(nodes[1]);
4210                 check_added_monitors!(nodes[1], 1);
4211                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4212                 assert_eq!(fail_commit.len(), 1);
4213                 match fail_commit[0] {
4214                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4215                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4216                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4217                         },
4218                         _ => unreachable!(),
4219                 }
4220                 expect_payment_failed!(nodes[0], second_payment_hash, false);
4221                 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4222                         match update {
4223                                 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4224                                 _ => panic!("Unexpected event"),
4225                         }
4226                 } else {
4227                         panic!("Unexpected event");
4228                 }
4229         } else {
4230                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4231         }
4232 }
4233
4234 #[test]
4235 fn test_holding_cell_htlc_add_timeouts() {
4236         do_test_holding_cell_htlc_add_timeouts(false);
4237         do_test_holding_cell_htlc_add_timeouts(true);
4238 }
4239
4240 #[test]
4241 fn test_invalid_channel_announcement() {
4242         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4243         let secp_ctx = Secp256k1::new();
4244         let chanmon_cfgs = create_chanmon_cfgs(2);
4245         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4246         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4247         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4248
4249         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4250
4251         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4252         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4253         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4254         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4255
4256         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 } );
4257
4258         let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4259         let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4260
4261         let as_network_key = nodes[0].node.get_our_node_id();
4262         let bs_network_key = nodes[1].node.get_our_node_id();
4263
4264         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4265
4266         let mut chan_announcement;
4267
4268         macro_rules! dummy_unsigned_msg {
4269                 () => {
4270                         msgs::UnsignedChannelAnnouncement {
4271                                 features: ChannelFeatures::known(),
4272                                 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4273                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4274                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4275                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4276                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4277                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4278                                 excess_data: Vec::new(),
4279                         };
4280                 }
4281         }
4282
4283         macro_rules! sign_msg {
4284                 ($unsigned_msg: expr) => {
4285                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4286                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4287                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4288                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4289                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4290                         chan_announcement = msgs::ChannelAnnouncement {
4291                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4292                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4293                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4294                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4295                                 contents: $unsigned_msg
4296                         }
4297                 }
4298         }
4299
4300         let unsigned_msg = dummy_unsigned_msg!();
4301         sign_msg!(unsigned_msg);
4302         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4303         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 } );
4304
4305         // Configured with Network::Testnet
4306         let mut unsigned_msg = dummy_unsigned_msg!();
4307         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4308         sign_msg!(unsigned_msg);
4309         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4310
4311         let mut unsigned_msg = dummy_unsigned_msg!();
4312         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4313         sign_msg!(unsigned_msg);
4314         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4315 }
4316
4317 #[test]
4318 fn test_no_txn_manager_serialize_deserialize() {
4319         let chanmon_cfgs = create_chanmon_cfgs(2);
4320         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4321         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4322         let logger: test_utils::TestLogger;
4323         let fee_estimator: test_utils::TestFeeEstimator;
4324         let persister: test_utils::TestPersister;
4325         let new_chain_monitor: test_utils::TestChainMonitor;
4326         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4327         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4328
4329         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4330
4331         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4332
4333         let nodes_0_serialized = nodes[0].node.encode();
4334         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4335         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4336
4337         logger = test_utils::TestLogger::new();
4338         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4339         persister = test_utils::TestPersister::new();
4340         let keys_manager = &chanmon_cfgs[0].keys_manager;
4341         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4342         nodes[0].chain_monitor = &new_chain_monitor;
4343         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4344         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4345                 &mut chan_0_monitor_read, keys_manager).unwrap();
4346         assert!(chan_0_monitor_read.is_empty());
4347
4348         let mut nodes_0_read = &nodes_0_serialized[..];
4349         let config = UserConfig::default();
4350         let (_, nodes_0_deserialized_tmp) = {
4351                 let mut channel_monitors = HashMap::new();
4352                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4353                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4354                         default_config: config,
4355                         keys_manager,
4356                         fee_estimator: &fee_estimator,
4357                         chain_monitor: nodes[0].chain_monitor,
4358                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4359                         logger: &logger,
4360                         channel_monitors,
4361                 }).unwrap()
4362         };
4363         nodes_0_deserialized = nodes_0_deserialized_tmp;
4364         assert!(nodes_0_read.is_empty());
4365
4366         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4367         nodes[0].node = &nodes_0_deserialized;
4368         assert_eq!(nodes[0].node.list_channels().len(), 1);
4369         check_added_monitors!(nodes[0], 1);
4370
4371         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4372         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4373         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4374         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4375
4376         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4377         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4378         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4379         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4380
4381         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4382         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4383         for node in nodes.iter() {
4384                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4385                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4386                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4387         }
4388
4389         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4390 }
4391
4392 #[test]
4393 fn test_dup_htlc_onchain_fails_on_reload() {
4394         // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4395         // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4396         // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4397         // the ChannelMonitor tells it to.
4398         //
4399         // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4400         // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4401         // PaymentFailed event appearing). However, because we may not serialize the relevant
4402         // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4403         // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4404         // and de-duplicates ChannelMonitor events.
4405         //
4406         // This tests that explicit tracking behavior.
4407         let chanmon_cfgs = create_chanmon_cfgs(2);
4408         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4409         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4410         let persister: test_utils::TestPersister;
4411         let new_chain_monitor: test_utils::TestChainMonitor;
4412         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4413         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4414
4415         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4416
4417         // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4418         // nodes[0].
4419         let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4420         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4421         check_closed_broadcast!(nodes[0], true);
4422         check_added_monitors!(nodes[0], 1);
4423
4424         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4425         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4426
4427         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4428         assert_eq!(node_txn.len(), 2);
4429
4430         assert!(nodes[1].node.claim_funds(payment_preimage));
4431         check_added_monitors!(nodes[1], 1);
4432
4433         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4434         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
4435         check_closed_broadcast!(nodes[1], true);
4436         check_added_monitors!(nodes[1], 1);
4437         let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4438
4439         connect_block(&nodes[0], &Block { header, txdata: node_txn});
4440
4441         // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4442         // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4443         // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4444         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4445         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4446
4447         header.prev_blockhash = header.block_hash();
4448         let claim_block = Block { header, txdata: claim_txn};
4449         connect_block(&nodes[0], &claim_block);
4450         expect_payment_sent!(nodes[0], payment_preimage);
4451
4452         // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4453         // connected a highly-relevant block, it likely gets serialized out now.
4454         let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4455         nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4456
4457         // Now reload nodes[0]...
4458         persister = test_utils::TestPersister::new();
4459         let keys_manager = &chanmon_cfgs[0].keys_manager;
4460         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);
4461         nodes[0].chain_monitor = &new_chain_monitor;
4462         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4463         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4464                 &mut chan_0_monitor_read, keys_manager).unwrap();
4465         assert!(chan_0_monitor_read.is_empty());
4466
4467         let (_, nodes_0_deserialized_tmp) = {
4468                 let mut channel_monitors = HashMap::new();
4469                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4470                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4471                         ::read(&mut std::io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4472                                 default_config: Default::default(),
4473                                 keys_manager,
4474                                 fee_estimator: node_cfgs[0].fee_estimator,
4475                                 chain_monitor: nodes[0].chain_monitor,
4476                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4477                                 logger: nodes[0].logger,
4478                                 channel_monitors,
4479                         }).unwrap()
4480         };
4481         nodes_0_deserialized = nodes_0_deserialized_tmp;
4482
4483         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4484         check_added_monitors!(nodes[0], 1);
4485         nodes[0].node = &nodes_0_deserialized;
4486
4487         // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4488         // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4489         // payment events should kick in, leaving us with no pending events here.
4490         nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, nodes[0].blocks.borrow().len() as u32 - 1);
4491         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4492 }
4493
4494 #[test]
4495 fn test_manager_serialize_deserialize_events() {
4496         // This test makes sure the events field in ChannelManager survives de/serialization
4497         let chanmon_cfgs = create_chanmon_cfgs(2);
4498         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4499         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4500         let fee_estimator: test_utils::TestFeeEstimator;
4501         let persister: test_utils::TestPersister;
4502         let logger: test_utils::TestLogger;
4503         let new_chain_monitor: test_utils::TestChainMonitor;
4504         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4505         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4506
4507         // Start creating a channel, but stop right before broadcasting the funding transaction
4508         let channel_value = 100000;
4509         let push_msat = 10001;
4510         let a_flags = InitFeatures::known();
4511         let b_flags = InitFeatures::known();
4512         let node_a = nodes.remove(0);
4513         let node_b = nodes.remove(0);
4514         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4515         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()));
4516         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()));
4517
4518         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4519
4520         node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4521         check_added_monitors!(node_a, 0);
4522
4523         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()));
4524         {
4525                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4526                 assert_eq!(added_monitors.len(), 1);
4527                 assert_eq!(added_monitors[0].0, funding_output);
4528                 added_monitors.clear();
4529         }
4530
4531         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()));
4532         {
4533                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4534                 assert_eq!(added_monitors.len(), 1);
4535                 assert_eq!(added_monitors[0].0, funding_output);
4536                 added_monitors.clear();
4537         }
4538         // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4539
4540         nodes.push(node_a);
4541         nodes.push(node_b);
4542
4543         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4544         let nodes_0_serialized = nodes[0].node.encode();
4545         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4546         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4547
4548         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4549         logger = test_utils::TestLogger::new();
4550         persister = test_utils::TestPersister::new();
4551         let keys_manager = &chanmon_cfgs[0].keys_manager;
4552         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4553         nodes[0].chain_monitor = &new_chain_monitor;
4554         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4555         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4556                 &mut chan_0_monitor_read, keys_manager).unwrap();
4557         assert!(chan_0_monitor_read.is_empty());
4558
4559         let mut nodes_0_read = &nodes_0_serialized[..];
4560         let config = UserConfig::default();
4561         let (_, nodes_0_deserialized_tmp) = {
4562                 let mut channel_monitors = HashMap::new();
4563                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4564                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4565                         default_config: config,
4566                         keys_manager,
4567                         fee_estimator: &fee_estimator,
4568                         chain_monitor: nodes[0].chain_monitor,
4569                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4570                         logger: &logger,
4571                         channel_monitors,
4572                 }).unwrap()
4573         };
4574         nodes_0_deserialized = nodes_0_deserialized_tmp;
4575         assert!(nodes_0_read.is_empty());
4576
4577         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4578
4579         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4580         nodes[0].node = &nodes_0_deserialized;
4581
4582         // After deserializing, make sure the funding_transaction is still held by the channel manager
4583         let events_4 = nodes[0].node.get_and_clear_pending_events();
4584         assert_eq!(events_4.len(), 0);
4585         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4586         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4587
4588         // Make sure the channel is functioning as though the de/serialization never happened
4589         assert_eq!(nodes[0].node.list_channels().len(), 1);
4590         check_added_monitors!(nodes[0], 1);
4591
4592         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4593         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4594         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4595         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4596
4597         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4598         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4599         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4600         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4601
4602         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4603         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4604         for node in nodes.iter() {
4605                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4606                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4607                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4608         }
4609
4610         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4611 }
4612
4613 #[test]
4614 fn test_simple_manager_serialize_deserialize() {
4615         let chanmon_cfgs = create_chanmon_cfgs(2);
4616         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4617         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4618         let logger: test_utils::TestLogger;
4619         let fee_estimator: test_utils::TestFeeEstimator;
4620         let persister: test_utils::TestPersister;
4621         let new_chain_monitor: test_utils::TestChainMonitor;
4622         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4623         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4624         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4625
4626         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4627         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4628
4629         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4630
4631         let nodes_0_serialized = nodes[0].node.encode();
4632         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4633         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4634
4635         logger = test_utils::TestLogger::new();
4636         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4637         persister = test_utils::TestPersister::new();
4638         let keys_manager = &chanmon_cfgs[0].keys_manager;
4639         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4640         nodes[0].chain_monitor = &new_chain_monitor;
4641         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4642         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4643                 &mut chan_0_monitor_read, keys_manager).unwrap();
4644         assert!(chan_0_monitor_read.is_empty());
4645
4646         let mut nodes_0_read = &nodes_0_serialized[..];
4647         let (_, nodes_0_deserialized_tmp) = {
4648                 let mut channel_monitors = HashMap::new();
4649                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4650                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4651                         default_config: UserConfig::default(),
4652                         keys_manager,
4653                         fee_estimator: &fee_estimator,
4654                         chain_monitor: nodes[0].chain_monitor,
4655                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4656                         logger: &logger,
4657                         channel_monitors,
4658                 }).unwrap()
4659         };
4660         nodes_0_deserialized = nodes_0_deserialized_tmp;
4661         assert!(nodes_0_read.is_empty());
4662
4663         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4664         nodes[0].node = &nodes_0_deserialized;
4665         check_added_monitors!(nodes[0], 1);
4666
4667         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4668
4669         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4670         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4671 }
4672
4673 #[test]
4674 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4675         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4676         let chanmon_cfgs = create_chanmon_cfgs(4);
4677         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4678         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4679         let logger: test_utils::TestLogger;
4680         let fee_estimator: test_utils::TestFeeEstimator;
4681         let persister: test_utils::TestPersister;
4682         let new_chain_monitor: test_utils::TestChainMonitor;
4683         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4684         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4685         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4686         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4687         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4688
4689         let mut node_0_stale_monitors_serialized = Vec::new();
4690         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4691                 let mut writer = test_utils::TestVecWriter(Vec::new());
4692                 monitor.1.write(&mut writer).unwrap();
4693                 node_0_stale_monitors_serialized.push(writer.0);
4694         }
4695
4696         let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4697
4698         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4699         let nodes_0_serialized = nodes[0].node.encode();
4700
4701         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4702         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4703         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4704         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4705
4706         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4707         // nodes[3])
4708         let mut node_0_monitors_serialized = Vec::new();
4709         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4710                 let mut writer = test_utils::TestVecWriter(Vec::new());
4711                 monitor.1.write(&mut writer).unwrap();
4712                 node_0_monitors_serialized.push(writer.0);
4713         }
4714
4715         logger = test_utils::TestLogger::new();
4716         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4717         persister = test_utils::TestPersister::new();
4718         let keys_manager = &chanmon_cfgs[0].keys_manager;
4719         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4720         nodes[0].chain_monitor = &new_chain_monitor;
4721
4722
4723         let mut node_0_stale_monitors = Vec::new();
4724         for serialized in node_0_stale_monitors_serialized.iter() {
4725                 let mut read = &serialized[..];
4726                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4727                 assert!(read.is_empty());
4728                 node_0_stale_monitors.push(monitor);
4729         }
4730
4731         let mut node_0_monitors = Vec::new();
4732         for serialized in node_0_monitors_serialized.iter() {
4733                 let mut read = &serialized[..];
4734                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4735                 assert!(read.is_empty());
4736                 node_0_monitors.push(monitor);
4737         }
4738
4739         let mut nodes_0_read = &nodes_0_serialized[..];
4740         if let Err(msgs::DecodeError::InvalidValue) =
4741                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4742                 default_config: UserConfig::default(),
4743                 keys_manager,
4744                 fee_estimator: &fee_estimator,
4745                 chain_monitor: nodes[0].chain_monitor,
4746                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4747                 logger: &logger,
4748                 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4749         }) { } else {
4750                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4751         };
4752
4753         let mut nodes_0_read = &nodes_0_serialized[..];
4754         let (_, nodes_0_deserialized_tmp) =
4755                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4756                 default_config: UserConfig::default(),
4757                 keys_manager,
4758                 fee_estimator: &fee_estimator,
4759                 chain_monitor: nodes[0].chain_monitor,
4760                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4761                 logger: &logger,
4762                 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4763         }).unwrap();
4764         nodes_0_deserialized = nodes_0_deserialized_tmp;
4765         assert!(nodes_0_read.is_empty());
4766
4767         { // Channel close should result in a commitment tx and an HTLC tx
4768                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4769                 assert_eq!(txn.len(), 2);
4770                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4771                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4772         }
4773
4774         for monitor in node_0_monitors.drain(..) {
4775                 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4776                 check_added_monitors!(nodes[0], 1);
4777         }
4778         nodes[0].node = &nodes_0_deserialized;
4779
4780         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4781         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4782         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4783         //... and we can even still claim the payment!
4784         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4785
4786         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4787         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4788         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4789         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4790         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4791         assert_eq!(msg_events.len(), 1);
4792         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4793                 match action {
4794                         &ErrorAction::SendErrorMessage { ref msg } => {
4795                                 assert_eq!(msg.channel_id, channel_id);
4796                         },
4797                         _ => panic!("Unexpected event!"),
4798                 }
4799         }
4800 }
4801
4802 macro_rules! check_spendable_outputs {
4803         ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4804                 {
4805                         let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4806                         let mut txn = Vec::new();
4807                         let mut all_outputs = Vec::new();
4808                         let secp_ctx = Secp256k1::new();
4809                         for event in events.drain(..) {
4810                                 match event {
4811                                         Event::SpendableOutputs { mut outputs } => {
4812                                                 for outp in outputs.drain(..) {
4813                                                         txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4814                                                         all_outputs.push(outp);
4815                                                 }
4816                                         },
4817                                         _ => panic!("Unexpected event"),
4818                                 };
4819                         }
4820                         if all_outputs.len() > 1 {
4821                                 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) {
4822                                         txn.push(tx);
4823                                 }
4824                         }
4825                         txn
4826                 }
4827         }
4828 }
4829
4830 #[test]
4831 fn test_claim_sizeable_push_msat() {
4832         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4833         let chanmon_cfgs = create_chanmon_cfgs(2);
4834         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4835         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4836         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4837
4838         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4839         nodes[1].node.force_close_channel(&chan.2).unwrap();
4840         check_closed_broadcast!(nodes[1], true);
4841         check_added_monitors!(nodes[1], 1);
4842         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4843         assert_eq!(node_txn.len(), 1);
4844         check_spends!(node_txn[0], chan.3);
4845         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
4846
4847         mine_transaction(&nodes[1], &node_txn[0]);
4848         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4849
4850         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4851         assert_eq!(spend_txn.len(), 1);
4852         check_spends!(spend_txn[0], node_txn[0]);
4853 }
4854
4855 #[test]
4856 fn test_claim_on_remote_sizeable_push_msat() {
4857         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4858         // to_remote output is encumbered by a P2WPKH
4859         let chanmon_cfgs = create_chanmon_cfgs(2);
4860         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4861         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4862         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4863
4864         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4865         nodes[0].node.force_close_channel(&chan.2).unwrap();
4866         check_closed_broadcast!(nodes[0], true);
4867         check_added_monitors!(nodes[0], 1);
4868
4869         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4870         assert_eq!(node_txn.len(), 1);
4871         check_spends!(node_txn[0], chan.3);
4872         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
4873
4874         mine_transaction(&nodes[1], &node_txn[0]);
4875         check_closed_broadcast!(nodes[1], true);
4876         check_added_monitors!(nodes[1], 1);
4877         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4878
4879         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4880         assert_eq!(spend_txn.len(), 1);
4881         check_spends!(spend_txn[0], node_txn[0]);
4882 }
4883
4884 #[test]
4885 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4886         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4887         // to_remote output is encumbered by a P2WPKH
4888
4889         let chanmon_cfgs = create_chanmon_cfgs(2);
4890         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4891         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4892         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4893
4894         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4895         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4896         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4897         assert_eq!(revoked_local_txn[0].input.len(), 1);
4898         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4899
4900         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4901         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4902         check_closed_broadcast!(nodes[1], true);
4903         check_added_monitors!(nodes[1], 1);
4904
4905         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4906         mine_transaction(&nodes[1], &node_txn[0]);
4907         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4908
4909         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4910         assert_eq!(spend_txn.len(), 3);
4911         check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4912         check_spends!(spend_txn[1], node_txn[0]);
4913         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4914 }
4915
4916 #[test]
4917 fn test_static_spendable_outputs_preimage_tx() {
4918         let chanmon_cfgs = create_chanmon_cfgs(2);
4919         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4920         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4921         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4922
4923         // Create some initial channels
4924         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4925
4926         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4927
4928         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4929         assert_eq!(commitment_tx[0].input.len(), 1);
4930         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4931
4932         // Settle A's commitment tx on B's chain
4933         assert!(nodes[1].node.claim_funds(payment_preimage));
4934         check_added_monitors!(nodes[1], 1);
4935         mine_transaction(&nodes[1], &commitment_tx[0]);
4936         check_added_monitors!(nodes[1], 1);
4937         let events = nodes[1].node.get_and_clear_pending_msg_events();
4938         match events[0] {
4939                 MessageSendEvent::UpdateHTLCs { .. } => {},
4940                 _ => panic!("Unexpected event"),
4941         }
4942         match events[1] {
4943                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4944                 _ => panic!("Unexepected event"),
4945         }
4946
4947         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4948         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4949         assert_eq!(node_txn.len(), 3);
4950         check_spends!(node_txn[0], commitment_tx[0]);
4951         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4952         check_spends!(node_txn[1], chan_1.3);
4953         check_spends!(node_txn[2], node_txn[1]);
4954
4955         mine_transaction(&nodes[1], &node_txn[0]);
4956         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4957
4958         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4959         assert_eq!(spend_txn.len(), 1);
4960         check_spends!(spend_txn[0], node_txn[0]);
4961 }
4962
4963 #[test]
4964 fn test_static_spendable_outputs_timeout_tx() {
4965         let chanmon_cfgs = create_chanmon_cfgs(2);
4966         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4967         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4968         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4969
4970         // Create some initial channels
4971         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4972
4973         // Rebalance the network a bit by relaying one payment through all the channels ...
4974         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4975
4976         let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4977
4978         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4979         assert_eq!(commitment_tx[0].input.len(), 1);
4980         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4981
4982         // Settle A's commitment tx on B' chain
4983         mine_transaction(&nodes[1], &commitment_tx[0]);
4984         check_added_monitors!(nodes[1], 1);
4985         let events = nodes[1].node.get_and_clear_pending_msg_events();
4986         match events[0] {
4987                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4988                 _ => panic!("Unexpected event"),
4989         }
4990
4991         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4992         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4993         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4994         check_spends!(node_txn[0],  commitment_tx[0].clone());
4995         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4996         check_spends!(node_txn[1], chan_1.3.clone());
4997         check_spends!(node_txn[2], node_txn[1]);
4998
4999         mine_transaction(&nodes[1], &node_txn[0]);
5000         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5001         expect_payment_failed!(nodes[1], our_payment_hash, true);
5002
5003         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5004         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
5005         check_spends!(spend_txn[0], commitment_tx[0]);
5006         check_spends!(spend_txn[1], node_txn[0]);
5007         check_spends!(spend_txn[2], node_txn[0], commitment_tx[0]); // All outputs
5008 }
5009
5010 #[test]
5011 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
5012         let chanmon_cfgs = create_chanmon_cfgs(2);
5013         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5014         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5015         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5016
5017         // Create some initial channels
5018         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5019
5020         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5021         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5022         assert_eq!(revoked_local_txn[0].input.len(), 1);
5023         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5024
5025         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5026
5027         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5028         check_closed_broadcast!(nodes[1], true);
5029         check_added_monitors!(nodes[1], 1);
5030
5031         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5032         assert_eq!(node_txn.len(), 2);
5033         assert_eq!(node_txn[0].input.len(), 2);
5034         check_spends!(node_txn[0], revoked_local_txn[0]);
5035
5036         mine_transaction(&nodes[1], &node_txn[0]);
5037         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5038
5039         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5040         assert_eq!(spend_txn.len(), 1);
5041         check_spends!(spend_txn[0], node_txn[0]);
5042 }
5043
5044 #[test]
5045 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5046         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5047         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
5048         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5049         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5050         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5051
5052         // Create some initial channels
5053         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5054
5055         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5056         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5057         assert_eq!(revoked_local_txn[0].input.len(), 1);
5058         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5059
5060         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5061
5062         // A will generate HTLC-Timeout from revoked commitment tx
5063         mine_transaction(&nodes[0], &revoked_local_txn[0]);
5064         check_closed_broadcast!(nodes[0], true);
5065         check_added_monitors!(nodes[0], 1);
5066
5067         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5068         assert_eq!(revoked_htlc_txn.len(), 2);
5069         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5070         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5071         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5072         check_spends!(revoked_htlc_txn[1], chan_1.3);
5073
5074         // B will generate justice tx from A's revoked commitment/HTLC tx
5075         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5076         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5077         check_closed_broadcast!(nodes[1], true);
5078         check_added_monitors!(nodes[1], 1);
5079
5080         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5081         assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
5082         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5083         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5084         // transactions next...
5085         assert_eq!(node_txn[0].input.len(), 3);
5086         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5087
5088         assert_eq!(node_txn[1].input.len(), 2);
5089         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[0]);
5090         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5091                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5092         } else {
5093                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5094                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5095         }
5096
5097         assert_eq!(node_txn[2].input.len(), 1);
5098         check_spends!(node_txn[2], chan_1.3);
5099
5100         mine_transaction(&nodes[1], &node_txn[1]);
5101         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5102
5103         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5104         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5105         assert_eq!(spend_txn.len(), 1);
5106         assert_eq!(spend_txn[0].input.len(), 1);
5107         check_spends!(spend_txn[0], node_txn[1]);
5108 }
5109
5110 #[test]
5111 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5112         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5113         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
5114         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5115         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5116         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5117
5118         // Create some initial channels
5119         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5120
5121         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5122         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5123         assert_eq!(revoked_local_txn[0].input.len(), 1);
5124         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5125
5126         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5127         assert_eq!(revoked_local_txn[0].output.len(), 2);
5128
5129         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5130
5131         // B will generate HTLC-Success from revoked commitment tx
5132         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5133         check_closed_broadcast!(nodes[1], true);
5134         check_added_monitors!(nodes[1], 1);
5135         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5136
5137         assert_eq!(revoked_htlc_txn.len(), 2);
5138         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5139         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5140         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5141
5142         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5143         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5144         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5145
5146         // A will generate justice tx from B's revoked commitment/HTLC tx
5147         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5148         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5149         check_closed_broadcast!(nodes[0], true);
5150         check_added_monitors!(nodes[0], 1);
5151
5152         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5153         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5154
5155         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5156         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5157         // transactions next...
5158         assert_eq!(node_txn[0].input.len(), 2);
5159         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5160         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5161                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5162         } else {
5163                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5164                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5165         }
5166
5167         assert_eq!(node_txn[1].input.len(), 1);
5168         check_spends!(node_txn[1], revoked_htlc_txn[0]);
5169
5170         check_spends!(node_txn[2], chan_1.3);
5171
5172         mine_transaction(&nodes[0], &node_txn[1]);
5173         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5174
5175         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5176         // didn't try to generate any new transactions.
5177
5178         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5179         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5180         assert_eq!(spend_txn.len(), 3);
5181         assert_eq!(spend_txn[0].input.len(), 1);
5182         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5183         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5184         check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5185         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5186 }
5187
5188 #[test]
5189 fn test_onchain_to_onchain_claim() {
5190         // Test that in case of channel closure, we detect the state of output and claim HTLC
5191         // on downstream peer's remote commitment tx.
5192         // First, have C claim an HTLC against its own latest commitment transaction.
5193         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5194         // channel.
5195         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5196         // gets broadcast.
5197
5198         let chanmon_cfgs = create_chanmon_cfgs(3);
5199         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5200         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5201         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5202
5203         // Create some initial channels
5204         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5205         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5206
5207         // Rebalance the network a bit by relaying one payment through all the channels ...
5208         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5209         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5210
5211         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5212         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5213         check_spends!(commitment_tx[0], chan_2.3);
5214         nodes[2].node.claim_funds(payment_preimage);
5215         check_added_monitors!(nodes[2], 1);
5216         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5217         assert!(updates.update_add_htlcs.is_empty());
5218         assert!(updates.update_fail_htlcs.is_empty());
5219         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5220         assert!(updates.update_fail_malformed_htlcs.is_empty());
5221
5222         mine_transaction(&nodes[2], &commitment_tx[0]);
5223         check_closed_broadcast!(nodes[2], true);
5224         check_added_monitors!(nodes[2], 1);
5225
5226         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5227         assert_eq!(c_txn.len(), 3);
5228         assert_eq!(c_txn[0], c_txn[2]);
5229         assert_eq!(commitment_tx[0], c_txn[1]);
5230         check_spends!(c_txn[1], chan_2.3);
5231         check_spends!(c_txn[2], c_txn[1]);
5232         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5233         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5234         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5235         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5236
5237         // 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
5238         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5239         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5240         {
5241                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5242                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
5243                 assert_eq!(b_txn.len(), 3);
5244                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
5245                 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5246                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5247                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5248                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5249                 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5250                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5251                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5252                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5253                 b_txn.clear();
5254         }
5255         check_added_monitors!(nodes[1], 1);
5256         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5257         assert_eq!(msg_events.len(), 3);
5258         check_added_monitors!(nodes[1], 1);
5259         match msg_events[0] {
5260                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5261                 _ => panic!("Unexpected event"),
5262         }
5263         match msg_events[1] {
5264                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5265                 _ => panic!("Unexpected event"),
5266         }
5267         match msg_events[2] {
5268                 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, .. } } => {
5269                         assert!(update_add_htlcs.is_empty());
5270                         assert!(update_fail_htlcs.is_empty());
5271                         assert_eq!(update_fulfill_htlcs.len(), 1);
5272                         assert!(update_fail_malformed_htlcs.is_empty());
5273                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5274                 },
5275                 _ => panic!("Unexpected event"),
5276         };
5277         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5278         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5279         mine_transaction(&nodes[1], &commitment_tx[0]);
5280         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5281         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5282         assert_eq!(b_txn.len(), 3);
5283         check_spends!(b_txn[1], chan_1.3);
5284         check_spends!(b_txn[2], b_txn[1]);
5285         check_spends!(b_txn[0], commitment_tx[0]);
5286         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5287         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5288         assert_eq!(b_txn[0].lock_time, 0); // Success tx
5289
5290         check_closed_broadcast!(nodes[1], true);
5291         check_added_monitors!(nodes[1], 1);
5292 }
5293
5294 #[test]
5295 fn test_duplicate_payment_hash_one_failure_one_success() {
5296         // Topology : A --> B --> C --> D
5297         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5298         // Note that because C will refuse to generate two payment secrets for the same payment hash,
5299         // we forward one of the payments onwards to D.
5300         let chanmon_cfgs = create_chanmon_cfgs(4);
5301         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5302         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
5303         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5304
5305         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5306         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5307         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5308
5309         let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5310
5311         let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5312         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
5313                 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
5314         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5315
5316         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5317         assert_eq!(commitment_txn[0].input.len(), 1);
5318         check_spends!(commitment_txn[0], chan_2.3);
5319
5320         mine_transaction(&nodes[1], &commitment_txn[0]);
5321         check_closed_broadcast!(nodes[1], true);
5322         check_added_monitors!(nodes[1], 1);
5323
5324         let htlc_timeout_tx;
5325         { // Extract one of the two HTLC-Timeout transaction
5326                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5327                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
5328                 assert_eq!(node_txn.len(), 5);
5329                 check_spends!(node_txn[0], commitment_txn[0]);
5330                 assert_eq!(node_txn[0].input.len(), 1);
5331                 check_spends!(node_txn[1], commitment_txn[0]);
5332                 assert_eq!(node_txn[1].input.len(), 1);
5333                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5334                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5335                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5336                 check_spends!(node_txn[2], chan_2.3);
5337                 check_spends!(node_txn[3], node_txn[2]);
5338                 check_spends!(node_txn[4], node_txn[2]);
5339                 htlc_timeout_tx = node_txn[1].clone();
5340         }
5341
5342         nodes[2].node.claim_funds(our_payment_preimage);
5343         mine_transaction(&nodes[2], &commitment_txn[0]);
5344         check_added_monitors!(nodes[2], 2);
5345         let events = nodes[2].node.get_and_clear_pending_msg_events();
5346         match events[0] {
5347                 MessageSendEvent::UpdateHTLCs { .. } => {},
5348                 _ => panic!("Unexpected event"),
5349         }
5350         match events[1] {
5351                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5352                 _ => panic!("Unexepected event"),
5353         }
5354         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5355         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)
5356         check_spends!(htlc_success_txn[2], chan_2.3);
5357         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
5358         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
5359         assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5360         assert_eq!(htlc_success_txn[0].input.len(), 1);
5361         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5362         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5363         assert_eq!(htlc_success_txn[1].input.len(), 1);
5364         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5365         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5366         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5367         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5368
5369         mine_transaction(&nodes[1], &htlc_timeout_tx);
5370         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5371         expect_pending_htlcs_forwardable!(nodes[1]);
5372         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5373         assert!(htlc_updates.update_add_htlcs.is_empty());
5374         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5375         let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5376         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5377         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5378         check_added_monitors!(nodes[1], 1);
5379
5380         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5381         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5382         {
5383                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5384                 let events = nodes[0].node.get_and_clear_pending_msg_events();
5385                 assert_eq!(events.len(), 1);
5386                 match events[0] {
5387                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
5388                         },
5389                         _ => { panic!("Unexpected event"); }
5390                 }
5391         }
5392         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5393
5394         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5395         mine_transaction(&nodes[1], &htlc_success_txn[0]);
5396         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5397         assert!(updates.update_add_htlcs.is_empty());
5398         assert!(updates.update_fail_htlcs.is_empty());
5399         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5400         assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5401         assert!(updates.update_fail_malformed_htlcs.is_empty());
5402         check_added_monitors!(nodes[1], 1);
5403
5404         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5405         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5406
5407         let events = nodes[0].node.get_and_clear_pending_events();
5408         match events[0] {
5409                 Event::PaymentSent { ref payment_preimage } => {
5410                         assert_eq!(*payment_preimage, our_payment_preimage);
5411                 }
5412                 _ => panic!("Unexpected event"),
5413         }
5414 }
5415
5416 #[test]
5417 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5418         let chanmon_cfgs = create_chanmon_cfgs(2);
5419         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5420         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5421         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5422
5423         // Create some initial channels
5424         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5425
5426         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5427         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5428         assert_eq!(local_txn.len(), 1);
5429         assert_eq!(local_txn[0].input.len(), 1);
5430         check_spends!(local_txn[0], chan_1.3);
5431
5432         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5433         nodes[1].node.claim_funds(payment_preimage);
5434         check_added_monitors!(nodes[1], 1);
5435         mine_transaction(&nodes[1], &local_txn[0]);
5436         check_added_monitors!(nodes[1], 1);
5437         let events = nodes[1].node.get_and_clear_pending_msg_events();
5438         match events[0] {
5439                 MessageSendEvent::UpdateHTLCs { .. } => {},
5440                 _ => panic!("Unexpected event"),
5441         }
5442         match events[1] {
5443                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5444                 _ => panic!("Unexepected event"),
5445         }
5446         let node_tx = {
5447                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5448                 assert_eq!(node_txn.len(), 3);
5449                 assert_eq!(node_txn[0], node_txn[2]);
5450                 assert_eq!(node_txn[1], local_txn[0]);
5451                 assert_eq!(node_txn[0].input.len(), 1);
5452                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5453                 check_spends!(node_txn[0], local_txn[0]);
5454                 node_txn[0].clone()
5455         };
5456
5457         mine_transaction(&nodes[1], &node_tx);
5458         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5459
5460         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5461         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5462         assert_eq!(spend_txn.len(), 1);
5463         check_spends!(spend_txn[0], node_tx);
5464 }
5465
5466 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5467         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5468         // unrevoked commitment transaction.
5469         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5470         // a remote RAA before they could be failed backwards (and combinations thereof).
5471         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5472         // use the same payment hashes.
5473         // Thus, we use a six-node network:
5474         //
5475         // A \         / E
5476         //    - C - D -
5477         // B /         \ F
5478         // And test where C fails back to A/B when D announces its latest commitment transaction
5479         let chanmon_cfgs = create_chanmon_cfgs(6);
5480         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5481         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5482         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5483         let logger = test_utils::TestLogger::new();
5484
5485         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5486         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5487         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5488         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5489         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5490
5491         // Rebalance and check output sanity...
5492         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5493         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5494         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5495
5496         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5497         // 0th HTLC:
5498         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
5499         // 1st HTLC:
5500         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
5501         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5502         let our_node_id = &nodes[1].node.get_our_node_id();
5503         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();
5504         // 2nd HTLC:
5505         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
5506         // 3rd HTLC:
5507         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
5508         // 4th HTLC:
5509         let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5510         // 5th HTLC:
5511         let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5512         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();
5513         // 6th HTLC:
5514         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());
5515         // 7th HTLC:
5516         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());
5517
5518         // 8th HTLC:
5519         let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5520         // 9th HTLC:
5521         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();
5522         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
5523
5524         // 10th HTLC:
5525         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
5526         // 11th HTLC:
5527         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();
5528         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());
5529
5530         // Double-check that six of the new HTLC were added
5531         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5532         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5533         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5534         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5535
5536         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5537         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5538         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5539         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5540         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5541         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5542         check_added_monitors!(nodes[4], 0);
5543         expect_pending_htlcs_forwardable!(nodes[4]);
5544         check_added_monitors!(nodes[4], 1);
5545
5546         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5547         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5548         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5549         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5550         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5551         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5552
5553         // Fail 3rd below-dust and 7th above-dust HTLCs
5554         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5555         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5556         check_added_monitors!(nodes[5], 0);
5557         expect_pending_htlcs_forwardable!(nodes[5]);
5558         check_added_monitors!(nodes[5], 1);
5559
5560         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5561         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5562         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5563         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5564
5565         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5566
5567         expect_pending_htlcs_forwardable!(nodes[3]);
5568         check_added_monitors!(nodes[3], 1);
5569         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5570         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5571         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5572         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5573         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5574         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5575         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5576         if deliver_last_raa {
5577                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5578         } else {
5579                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5580         }
5581
5582         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5583         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5584         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5585         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5586         //
5587         // We now broadcast the latest commitment transaction, which *should* result in failures for
5588         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5589         // the non-broadcast above-dust HTLCs.
5590         //
5591         // Alternatively, we may broadcast the previous commitment transaction, which should only
5592         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5593         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5594
5595         if announce_latest {
5596                 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5597         } else {
5598                 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5599         }
5600         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5601         check_closed_broadcast!(nodes[2], true);
5602         expect_pending_htlcs_forwardable!(nodes[2]);
5603         check_added_monitors!(nodes[2], 3);
5604
5605         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5606         assert_eq!(cs_msgs.len(), 2);
5607         let mut a_done = false;
5608         for msg in cs_msgs {
5609                 match msg {
5610                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5611                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5612                                 // should be failed-backwards here.
5613                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5614                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5615                                         for htlc in &updates.update_fail_htlcs {
5616                                                 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 });
5617                                         }
5618                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5619                                         assert!(!a_done);
5620                                         a_done = true;
5621                                         &nodes[0]
5622                                 } else {
5623                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5624                                         for htlc in &updates.update_fail_htlcs {
5625                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5626                                         }
5627                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5628                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5629                                         &nodes[1]
5630                                 };
5631                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5632                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5633                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5634                                 if announce_latest {
5635                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5636                                         if *node_id == nodes[0].node.get_our_node_id() {
5637                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5638                                         }
5639                                 }
5640                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5641                         },
5642                         _ => panic!("Unexpected event"),
5643                 }
5644         }
5645
5646         let as_events = nodes[0].node.get_and_clear_pending_events();
5647         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5648         let mut as_failds = HashSet::new();
5649         for event in as_events.iter() {
5650                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5651                         assert!(as_failds.insert(*payment_hash));
5652                         if *payment_hash != payment_hash_2 {
5653                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5654                         } else {
5655                                 assert!(!rejected_by_dest);
5656                         }
5657                 } else { panic!("Unexpected event"); }
5658         }
5659         assert!(as_failds.contains(&payment_hash_1));
5660         assert!(as_failds.contains(&payment_hash_2));
5661         if announce_latest {
5662                 assert!(as_failds.contains(&payment_hash_3));
5663                 assert!(as_failds.contains(&payment_hash_5));
5664         }
5665         assert!(as_failds.contains(&payment_hash_6));
5666
5667         let bs_events = nodes[1].node.get_and_clear_pending_events();
5668         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5669         let mut bs_failds = HashSet::new();
5670         for event in bs_events.iter() {
5671                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5672                         assert!(bs_failds.insert(*payment_hash));
5673                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5674                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5675                         } else {
5676                                 assert!(!rejected_by_dest);
5677                         }
5678                 } else { panic!("Unexpected event"); }
5679         }
5680         assert!(bs_failds.contains(&payment_hash_1));
5681         assert!(bs_failds.contains(&payment_hash_2));
5682         if announce_latest {
5683                 assert!(bs_failds.contains(&payment_hash_4));
5684         }
5685         assert!(bs_failds.contains(&payment_hash_5));
5686
5687         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5688         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5689         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5690         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5691         // PaymentFailureNetworkUpdates.
5692         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5693         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5694         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5695         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5696         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5697                 match event {
5698                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5699                         _ => panic!("Unexpected event"),
5700                 }
5701         }
5702 }
5703
5704 #[test]
5705 fn test_fail_backwards_latest_remote_announce_a() {
5706         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5707 }
5708
5709 #[test]
5710 fn test_fail_backwards_latest_remote_announce_b() {
5711         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5712 }
5713
5714 #[test]
5715 fn test_fail_backwards_previous_remote_announce() {
5716         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5717         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5718         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5719 }
5720
5721 #[test]
5722 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5723         let chanmon_cfgs = create_chanmon_cfgs(2);
5724         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5725         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5726         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5727
5728         // Create some initial channels
5729         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5730
5731         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5732         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5733         assert_eq!(local_txn[0].input.len(), 1);
5734         check_spends!(local_txn[0], chan_1.3);
5735
5736         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5737         mine_transaction(&nodes[0], &local_txn[0]);
5738         check_closed_broadcast!(nodes[0], true);
5739         check_added_monitors!(nodes[0], 1);
5740
5741         let htlc_timeout = {
5742                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5743                 assert_eq!(node_txn[0].input.len(), 1);
5744                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5745                 check_spends!(node_txn[0], local_txn[0]);
5746                 node_txn[0].clone()
5747         };
5748
5749         mine_transaction(&nodes[0], &htlc_timeout);
5750         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5751         expect_payment_failed!(nodes[0], our_payment_hash, true);
5752
5753         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5754         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5755         assert_eq!(spend_txn.len(), 3);
5756         check_spends!(spend_txn[0], local_txn[0]);
5757         check_spends!(spend_txn[1], htlc_timeout);
5758         check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5759 }
5760
5761 #[test]
5762 fn test_key_derivation_params() {
5763         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5764         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5765         // let us re-derive the channel key set to then derive a delayed_payment_key.
5766
5767         let chanmon_cfgs = create_chanmon_cfgs(3);
5768
5769         // We manually create the node configuration to backup the seed.
5770         let seed = [42; 32];
5771         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5772         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);
5773         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 };
5774         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5775         node_cfgs.remove(0);
5776         node_cfgs.insert(0, node);
5777
5778         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5779         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5780
5781         // Create some initial channels
5782         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5783         // for node 0
5784         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5785         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5786         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5787
5788         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5789         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5790         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5791         assert_eq!(local_txn_1[0].input.len(), 1);
5792         check_spends!(local_txn_1[0], chan_1.3);
5793
5794         // We check funding pubkey are unique
5795         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]));
5796         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]));
5797         if from_0_funding_key_0 == from_1_funding_key_0
5798             || from_0_funding_key_0 == from_1_funding_key_1
5799             || from_0_funding_key_1 == from_1_funding_key_0
5800             || from_0_funding_key_1 == from_1_funding_key_1 {
5801                 panic!("Funding pubkeys aren't unique");
5802         }
5803
5804         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5805         mine_transaction(&nodes[0], &local_txn_1[0]);
5806         check_closed_broadcast!(nodes[0], true);
5807         check_added_monitors!(nodes[0], 1);
5808
5809         let htlc_timeout = {
5810                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5811                 assert_eq!(node_txn[0].input.len(), 1);
5812                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5813                 check_spends!(node_txn[0], local_txn_1[0]);
5814                 node_txn[0].clone()
5815         };
5816
5817         mine_transaction(&nodes[0], &htlc_timeout);
5818         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5819         expect_payment_failed!(nodes[0], our_payment_hash, true);
5820
5821         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5822         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5823         let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5824         assert_eq!(spend_txn.len(), 3);
5825         check_spends!(spend_txn[0], local_txn_1[0]);
5826         check_spends!(spend_txn[1], htlc_timeout);
5827         check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5828 }
5829
5830 #[test]
5831 fn test_static_output_closing_tx() {
5832         let chanmon_cfgs = create_chanmon_cfgs(2);
5833         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5834         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5835         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5836
5837         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5838
5839         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5840         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5841
5842         mine_transaction(&nodes[0], &closing_tx);
5843         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5844
5845         let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5846         assert_eq!(spend_txn.len(), 1);
5847         check_spends!(spend_txn[0], closing_tx);
5848
5849         mine_transaction(&nodes[1], &closing_tx);
5850         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5851
5852         let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5853         assert_eq!(spend_txn.len(), 1);
5854         check_spends!(spend_txn[0], closing_tx);
5855 }
5856
5857 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5858         let chanmon_cfgs = create_chanmon_cfgs(2);
5859         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5860         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5861         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5862         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5863
5864         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5865
5866         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5867         // present in B's local commitment transaction, but none of A's commitment transactions.
5868         assert!(nodes[1].node.claim_funds(our_payment_preimage));
5869         check_added_monitors!(nodes[1], 1);
5870
5871         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5872         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5873         let events = nodes[0].node.get_and_clear_pending_events();
5874         assert_eq!(events.len(), 1);
5875         match events[0] {
5876                 Event::PaymentSent { payment_preimage } => {
5877                         assert_eq!(payment_preimage, our_payment_preimage);
5878                 },
5879                 _ => panic!("Unexpected event"),
5880         }
5881
5882         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5883         check_added_monitors!(nodes[0], 1);
5884         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5885         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5886         check_added_monitors!(nodes[1], 1);
5887
5888         let starting_block = nodes[1].best_block_info();
5889         let mut block = Block {
5890                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5891                 txdata: vec![],
5892         };
5893         for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5894                 connect_block(&nodes[1], &block);
5895                 block.header.prev_blockhash = block.block_hash();
5896         }
5897         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5898         check_closed_broadcast!(nodes[1], true);
5899         check_added_monitors!(nodes[1], 1);
5900 }
5901
5902 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
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 mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5907         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5908         let logger = test_utils::TestLogger::new();
5909
5910         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
5911         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5912         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();
5913         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5914         check_added_monitors!(nodes[0], 1);
5915
5916         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5917
5918         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5919         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5920         // to "time out" the HTLC.
5921
5922         let starting_block = nodes[1].best_block_info();
5923         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5924
5925         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5926                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5927                 header.prev_blockhash = header.block_hash();
5928         }
5929         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5930         check_closed_broadcast!(nodes[0], true);
5931         check_added_monitors!(nodes[0], 1);
5932 }
5933
5934 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5935         let chanmon_cfgs = create_chanmon_cfgs(3);
5936         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5937         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5938         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5939         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5940
5941         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5942         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5943         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5944         // actually revoked.
5945         let htlc_value = if use_dust { 50000 } else { 3000000 };
5946         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5947         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
5948         expect_pending_htlcs_forwardable!(nodes[1]);
5949         check_added_monitors!(nodes[1], 1);
5950
5951         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5952         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
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         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5959         check_added_monitors!(nodes[1], 1);
5960         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5961
5962         if check_revoke_no_close {
5963                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5964                 check_added_monitors!(nodes[0], 1);
5965         }
5966
5967         let starting_block = nodes[1].best_block_info();
5968         let mut block = Block {
5969                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5970                 txdata: vec![],
5971         };
5972         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
5973                 connect_block(&nodes[0], &block);
5974                 block.header.prev_blockhash = block.block_hash();
5975         }
5976         if !check_revoke_no_close {
5977                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5978                 check_closed_broadcast!(nodes[0], true);
5979                 check_added_monitors!(nodes[0], 1);
5980         } else {
5981                 expect_payment_failed!(nodes[0], our_payment_hash, true);
5982         }
5983 }
5984
5985 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5986 // There are only a few cases to test here:
5987 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5988 //    broadcastable commitment transactions result in channel closure,
5989 //  * its included in an unrevoked-but-previous remote commitment transaction,
5990 //  * its included in the latest remote or local commitment transactions.
5991 // We test each of the three possible commitment transactions individually and use both dust and
5992 // non-dust HTLCs.
5993 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5994 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5995 // tested for at least one of the cases in other tests.
5996 #[test]
5997 fn htlc_claim_single_commitment_only_a() {
5998         do_htlc_claim_local_commitment_only(true);
5999         do_htlc_claim_local_commitment_only(false);
6000
6001         do_htlc_claim_current_remote_commitment_only(true);
6002         do_htlc_claim_current_remote_commitment_only(false);
6003 }
6004
6005 #[test]
6006 fn htlc_claim_single_commitment_only_b() {
6007         do_htlc_claim_previous_remote_commitment_only(true, false);
6008         do_htlc_claim_previous_remote_commitment_only(false, false);
6009         do_htlc_claim_previous_remote_commitment_only(true, true);
6010         do_htlc_claim_previous_remote_commitment_only(false, true);
6011 }
6012
6013 #[test]
6014 #[should_panic]
6015 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6016         let chanmon_cfgs = create_chanmon_cfgs(2);
6017         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6018         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6019         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6020         //Force duplicate channel ids
6021         for node in nodes.iter() {
6022                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6023         }
6024
6025         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6026         let channel_value_satoshis=10000;
6027         let push_msat=10001;
6028         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6029         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6030         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6031
6032         //Create a second channel with a channel_id collision
6033         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6034 }
6035
6036 #[test]
6037 fn bolt2_open_channel_sending_node_checks_part2() {
6038         let chanmon_cfgs = create_chanmon_cfgs(2);
6039         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6040         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6041         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6042
6043         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6044         let channel_value_satoshis=2^24;
6045         let push_msat=10001;
6046         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6047
6048         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6049         let channel_value_satoshis=10000;
6050         // Test when push_msat is equal to 1000 * funding_satoshis.
6051         let push_msat=1000*channel_value_satoshis+1;
6052         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6053
6054         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6055         let channel_value_satoshis=10000;
6056         let push_msat=10001;
6057         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
6058         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6059         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6060
6061         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6062         // 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
6063         assert!(node0_to_1_send_open_channel.channel_flags<=1);
6064
6065         // 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.
6066         assert!(BREAKDOWN_TIMEOUT>0);
6067         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6068
6069         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6070         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6071         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6072
6073         // 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.
6074         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6075         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6076         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6077         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6078         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6079 }
6080
6081 #[test]
6082 fn bolt2_open_channel_sane_dust_limit() {
6083         let chanmon_cfgs = create_chanmon_cfgs(2);
6084         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6085         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6086         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6087
6088         let channel_value_satoshis=1000000;
6089         let push_msat=10001;
6090         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6091         let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6092         node0_to_1_send_open_channel.dust_limit_satoshis = 661;
6093         node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
6094
6095         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6096         let events = nodes[1].node.get_and_clear_pending_msg_events();
6097         let err_msg = match events[0] {
6098                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
6099                         msg.clone()
6100                 },
6101                 _ => panic!("Unexpected event"),
6102         };
6103         assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
6104 }
6105
6106 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6107 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6108 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6109 // is no longer affordable once it's freed.
6110 #[test]
6111 fn test_fail_holding_cell_htlc_upon_free() {
6112         let chanmon_cfgs = create_chanmon_cfgs(2);
6113         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6114         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6115         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6116         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6117         let logger = test_utils::TestLogger::new();
6118
6119         // First nodes[0] generates an update_fee, setting the channel's
6120         // pending_update_fee.
6121         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6122         check_added_monitors!(nodes[0], 1);
6123
6124         let events = nodes[0].node.get_and_clear_pending_msg_events();
6125         assert_eq!(events.len(), 1);
6126         let (update_msg, commitment_signed) = match events[0] {
6127                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6128                         (update_fee.as_ref(), commitment_signed)
6129                 },
6130                 _ => panic!("Unexpected event"),
6131         };
6132
6133         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6134
6135         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6136         let channel_reserve = chan_stat.channel_reserve_msat;
6137         let feerate = get_feerate!(nodes[0], chan.2);
6138
6139         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6140         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6141         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6142         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6143         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();
6144
6145         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6146         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6147         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6148         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6149
6150         // Flush the pending fee update.
6151         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6152         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6153         check_added_monitors!(nodes[1], 1);
6154         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6155         check_added_monitors!(nodes[0], 1);
6156
6157         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6158         // HTLC, but now that the fee has been raised the payment will now fail, causing
6159         // us to surface its failure to the user.
6160         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6161         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6162         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 1 HTLC updates".to_string(), 1);
6163         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 ({})", log_bytes!(our_payment_hash.0), chan_stat.channel_reserve_msat);
6164         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6165
6166         // Check that the payment failed to be sent out.
6167         let events = nodes[0].node.get_and_clear_pending_events();
6168         assert_eq!(events.len(), 1);
6169         match &events[0] {
6170                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6171                         assert_eq!(our_payment_hash.clone(), *payment_hash);
6172                         assert_eq!(*rejected_by_dest, false);
6173                         assert_eq!(*error_code, None);
6174                         assert_eq!(*error_data, None);
6175                 },
6176                 _ => panic!("Unexpected event"),
6177         }
6178 }
6179
6180 // Test that if multiple HTLCs are released from the holding cell and one is
6181 // valid but the other is no longer valid upon release, the valid HTLC can be
6182 // successfully completed while the other one fails as expected.
6183 #[test]
6184 fn test_free_and_fail_holding_cell_htlcs() {
6185         let chanmon_cfgs = create_chanmon_cfgs(2);
6186         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6187         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6188         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6189         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6190         let logger = test_utils::TestLogger::new();
6191
6192         // First nodes[0] generates an update_fee, setting the channel's
6193         // pending_update_fee.
6194         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6195         check_added_monitors!(nodes[0], 1);
6196
6197         let events = nodes[0].node.get_and_clear_pending_msg_events();
6198         assert_eq!(events.len(), 1);
6199         let (update_msg, commitment_signed) = match events[0] {
6200                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6201                         (update_fee.as_ref(), commitment_signed)
6202                 },
6203                 _ => panic!("Unexpected event"),
6204         };
6205
6206         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6207
6208         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6209         let channel_reserve = chan_stat.channel_reserve_msat;
6210         let feerate = get_feerate!(nodes[0], chan.2);
6211
6212         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6213         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6214         let amt_1 = 20000;
6215         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6216         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6217         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6218         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();
6219         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();
6220
6221         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6222         nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6223         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6224         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6225         nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6226         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6227         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6228
6229         // Flush the pending fee update.
6230         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6231         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6232         check_added_monitors!(nodes[1], 1);
6233         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6234         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6235         check_added_monitors!(nodes[0], 2);
6236
6237         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6238         // but now that the fee has been raised the second payment will now fail, causing us
6239         // to surface its failure to the user. The first payment should succeed.
6240         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6241         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6242         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 2 HTLC updates".to_string(), 1);
6243         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 ({})", log_bytes!(payment_hash_2.0), chan_stat.channel_reserve_msat);
6244         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6245
6246         // Check that the second payment failed to be sent out.
6247         let events = nodes[0].node.get_and_clear_pending_events();
6248         assert_eq!(events.len(), 1);
6249         match &events[0] {
6250                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6251                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6252                         assert_eq!(*rejected_by_dest, false);
6253                         assert_eq!(*error_code, None);
6254                         assert_eq!(*error_data, None);
6255                 },
6256                 _ => panic!("Unexpected event"),
6257         }
6258
6259         // Complete the first payment and the RAA from the fee update.
6260         let (payment_event, send_raa_event) = {
6261                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6262                 assert_eq!(msgs.len(), 2);
6263                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6264         };
6265         let raa = match send_raa_event {
6266                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6267                 _ => panic!("Unexpected event"),
6268         };
6269         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6270         check_added_monitors!(nodes[1], 1);
6271         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6272         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6273         let events = nodes[1].node.get_and_clear_pending_events();
6274         assert_eq!(events.len(), 1);
6275         match events[0] {
6276                 Event::PendingHTLCsForwardable { .. } => {},
6277                 _ => panic!("Unexpected event"),
6278         }
6279         nodes[1].node.process_pending_htlc_forwards();
6280         let events = nodes[1].node.get_and_clear_pending_events();
6281         assert_eq!(events.len(), 1);
6282         match events[0] {
6283                 Event::PaymentReceived { .. } => {},
6284                 _ => panic!("Unexpected event"),
6285         }
6286         nodes[1].node.claim_funds(payment_preimage_1);
6287         check_added_monitors!(nodes[1], 1);
6288         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6289         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6290         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6291         let events = nodes[0].node.get_and_clear_pending_events();
6292         assert_eq!(events.len(), 1);
6293         match events[0] {
6294                 Event::PaymentSent { ref payment_preimage } => {
6295                         assert_eq!(*payment_preimage, payment_preimage_1);
6296                 }
6297                 _ => panic!("Unexpected event"),
6298         }
6299 }
6300
6301 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6302 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6303 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6304 // once it's freed.
6305 #[test]
6306 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6307         let chanmon_cfgs = create_chanmon_cfgs(3);
6308         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6309         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6310         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6311         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6312         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6313         let logger = test_utils::TestLogger::new();
6314
6315         // First nodes[1] generates an update_fee, setting the channel's
6316         // pending_update_fee.
6317         nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6318         check_added_monitors!(nodes[1], 1);
6319
6320         let events = nodes[1].node.get_and_clear_pending_msg_events();
6321         assert_eq!(events.len(), 1);
6322         let (update_msg, commitment_signed) = match events[0] {
6323                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6324                         (update_fee.as_ref(), commitment_signed)
6325                 },
6326                 _ => panic!("Unexpected event"),
6327         };
6328
6329         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6330
6331         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6332         let channel_reserve = chan_stat.channel_reserve_msat;
6333         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6334
6335         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6336         let feemsat = 239;
6337         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6338         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6339         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6340         let payment_event = {
6341                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6342                 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();
6343                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6344                 check_added_monitors!(nodes[0], 1);
6345
6346                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6347                 assert_eq!(events.len(), 1);
6348
6349                 SendEvent::from_event(events.remove(0))
6350         };
6351         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6352         check_added_monitors!(nodes[1], 0);
6353         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6354         expect_pending_htlcs_forwardable!(nodes[1]);
6355
6356         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6357         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6358
6359         // Flush the pending fee update.
6360         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6361         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6362         check_added_monitors!(nodes[2], 1);
6363         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6364         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6365         check_added_monitors!(nodes[1], 2);
6366
6367         // A final RAA message is generated to finalize the fee update.
6368         let events = nodes[1].node.get_and_clear_pending_msg_events();
6369         assert_eq!(events.len(), 1);
6370
6371         let raa_msg = match &events[0] {
6372                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6373                         msg.clone()
6374                 },
6375                 _ => panic!("Unexpected event"),
6376         };
6377
6378         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6379         check_added_monitors!(nodes[2], 1);
6380         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6381
6382         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6383         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6384         assert_eq!(process_htlc_forwards_event.len(), 1);
6385         match &process_htlc_forwards_event[0] {
6386                 &Event::PendingHTLCsForwardable { .. } => {},
6387                 _ => panic!("Unexpected event"),
6388         }
6389
6390         // In response, we call ChannelManager's process_pending_htlc_forwards
6391         nodes[1].node.process_pending_htlc_forwards();
6392         check_added_monitors!(nodes[1], 1);
6393
6394         // This causes the HTLC to be failed backwards.
6395         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6396         assert_eq!(fail_event.len(), 1);
6397         let (fail_msg, commitment_signed) = match &fail_event[0] {
6398                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6399                         assert_eq!(updates.update_add_htlcs.len(), 0);
6400                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6401                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6402                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6403                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6404                 },
6405                 _ => panic!("Unexpected event"),
6406         };
6407
6408         // Pass the failure messages back to nodes[0].
6409         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6410         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6411
6412         // Complete the HTLC failure+removal process.
6413         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6414         check_added_monitors!(nodes[0], 1);
6415         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6416         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6417         check_added_monitors!(nodes[1], 2);
6418         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6419         assert_eq!(final_raa_event.len(), 1);
6420         let raa = match &final_raa_event[0] {
6421                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6422                 _ => panic!("Unexpected event"),
6423         };
6424         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6425         let fail_msg_event = nodes[0].node.get_and_clear_pending_msg_events();
6426         assert_eq!(fail_msg_event.len(), 1);
6427         match &fail_msg_event[0] {
6428                 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
6429                 _ => panic!("Unexpected event"),
6430         }
6431         let failure_event = nodes[0].node.get_and_clear_pending_events();
6432         assert_eq!(failure_event.len(), 1);
6433         match &failure_event[0] {
6434                 &Event::PaymentFailed { rejected_by_dest, .. } => {
6435                         assert!(!rejected_by_dest);
6436                 },
6437                 _ => panic!("Unexpected event"),
6438         }
6439         check_added_monitors!(nodes[0], 1);
6440 }
6441
6442 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6443 // 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.
6444 //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.
6445
6446 #[test]
6447 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6448         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6449         let chanmon_cfgs = create_chanmon_cfgs(2);
6450         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6451         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6452         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6453         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6454
6455         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6456         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6457         let logger = test_utils::TestLogger::new();
6458         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();
6459         route.paths[0][0].fee_msat = 100;
6460
6461         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6462                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6463         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6464         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6465 }
6466
6467 #[test]
6468 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6469         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6470         let chanmon_cfgs = create_chanmon_cfgs(2);
6471         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6472         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6473         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6474         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6475         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6476
6477         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6478         let logger = test_utils::TestLogger::new();
6479         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();
6480         route.paths[0][0].fee_msat = 0;
6481         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6482                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6483
6484         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6485         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6486 }
6487
6488 #[test]
6489 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6490         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6491         let chanmon_cfgs = create_chanmon_cfgs(2);
6492         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6493         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6494         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6495         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6496
6497         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6498         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6499         let logger = test_utils::TestLogger::new();
6500         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();
6501         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6502         check_added_monitors!(nodes[0], 1);
6503         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6504         updates.update_add_htlcs[0].amount_msat = 0;
6505
6506         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6507         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6508         check_closed_broadcast!(nodes[1], true).unwrap();
6509         check_added_monitors!(nodes[1], 1);
6510 }
6511
6512 #[test]
6513 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6514         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6515         //It is enforced when constructing a route.
6516         let chanmon_cfgs = create_chanmon_cfgs(2);
6517         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6518         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6519         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6520         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6521         let logger = test_utils::TestLogger::new();
6522
6523         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6524
6525         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6526         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();
6527         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6528                 assert_eq!(err, &"Channel CLTV overflowed?"));
6529 }
6530
6531 #[test]
6532 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6533         //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.
6534         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6535         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6536         let chanmon_cfgs = create_chanmon_cfgs(2);
6537         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6538         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6539         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6540         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6541         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6542
6543         let logger = test_utils::TestLogger::new();
6544         for i in 0..max_accepted_htlcs {
6545                 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6546                 let payment_event = {
6547                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6548                         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();
6549                         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6550                         check_added_monitors!(nodes[0], 1);
6551
6552                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6553                         assert_eq!(events.len(), 1);
6554                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6555                                 assert_eq!(htlcs[0].htlc_id, i);
6556                         } else {
6557                                 assert!(false);
6558                         }
6559                         SendEvent::from_event(events.remove(0))
6560                 };
6561                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6562                 check_added_monitors!(nodes[1], 0);
6563                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6564
6565                 expect_pending_htlcs_forwardable!(nodes[1]);
6566                 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6567         }
6568         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6569         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6570         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();
6571         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6572                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6573
6574         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6575         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6576 }
6577
6578 #[test]
6579 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6580         //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.
6581         let chanmon_cfgs = create_chanmon_cfgs(2);
6582         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6583         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6584         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6585         let channel_value = 100000;
6586         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6587         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6588
6589         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6590
6591         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6592         // Manually create a route over our max in flight (which our router normally automatically
6593         // limits us to.
6594         let route = Route { paths: vec![vec![RouteHop {
6595            pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6596            short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6597            fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6598         }]] };
6599         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6600                 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)));
6601
6602         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6603         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);
6604
6605         send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6606 }
6607
6608 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6609 #[test]
6610 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6611         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6612         let chanmon_cfgs = create_chanmon_cfgs(2);
6613         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6614         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6615         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6616         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6617         let htlc_minimum_msat: u64;
6618         {
6619                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6620                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6621                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6622         }
6623
6624         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6625         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6626         let logger = test_utils::TestLogger::new();
6627         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();
6628         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6629         check_added_monitors!(nodes[0], 1);
6630         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6631         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6632         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6633         assert!(nodes[1].node.list_channels().is_empty());
6634         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6635         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()));
6636         check_added_monitors!(nodes[1], 1);
6637 }
6638
6639 #[test]
6640 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6641         //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
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 chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6647         let logger = test_utils::TestLogger::new();
6648
6649         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6650         let channel_reserve = chan_stat.channel_reserve_msat;
6651         let feerate = get_feerate!(nodes[0], chan.2);
6652         // The 2* and +1 are for the fee spike reserve.
6653         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6654
6655         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6656         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6657         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6658         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();
6659         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6660         check_added_monitors!(nodes[0], 1);
6661         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6662
6663         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6664         // at this time channel-initiatee receivers are not required to enforce that senders
6665         // respect the fee_spike_reserve.
6666         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6667         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6668
6669         assert!(nodes[1].node.list_channels().is_empty());
6670         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6671         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6672         check_added_monitors!(nodes[1], 1);
6673 }
6674
6675 #[test]
6676 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6677         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6678         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6679         let chanmon_cfgs = create_chanmon_cfgs(2);
6680         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6681         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6682         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6683         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6684         let logger = test_utils::TestLogger::new();
6685
6686         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6687         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6688
6689         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6690         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();
6691
6692         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6693         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6694         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height).unwrap();
6695         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6696
6697         let mut msg = msgs::UpdateAddHTLC {
6698                 channel_id: chan.2,
6699                 htlc_id: 0,
6700                 amount_msat: 1000,
6701                 payment_hash: our_payment_hash,
6702                 cltv_expiry: htlc_cltv,
6703                 onion_routing_packet: onion_packet.clone(),
6704         };
6705
6706         for i in 0..super::channel::OUR_MAX_HTLCS {
6707                 msg.htlc_id = i as u64;
6708                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6709         }
6710         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6711         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6712
6713         assert!(nodes[1].node.list_channels().is_empty());
6714         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6715         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6716         check_added_monitors!(nodes[1], 1);
6717 }
6718
6719 #[test]
6720 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6721         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6722         let chanmon_cfgs = create_chanmon_cfgs(2);
6723         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6724         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6725         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6726         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6727         let logger = test_utils::TestLogger::new();
6728
6729         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6730         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6731         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();
6732         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6733         check_added_monitors!(nodes[0], 1);
6734         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6735         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6736         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6737
6738         assert!(nodes[1].node.list_channels().is_empty());
6739         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6740         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6741         check_added_monitors!(nodes[1], 1);
6742 }
6743
6744 #[test]
6745 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6746         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6747         let chanmon_cfgs = create_chanmon_cfgs(2);
6748         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6749         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6750         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6751         let logger = test_utils::TestLogger::new();
6752
6753         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6754         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6755         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6756         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();
6757         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6758         check_added_monitors!(nodes[0], 1);
6759         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6760         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6761         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6762
6763         assert!(nodes[1].node.list_channels().is_empty());
6764         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6765         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6766         check_added_monitors!(nodes[1], 1);
6767 }
6768
6769 #[test]
6770 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6771         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6772         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6773         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6774         let chanmon_cfgs = create_chanmon_cfgs(2);
6775         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6776         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6777         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6778         let logger = test_utils::TestLogger::new();
6779
6780         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6781         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6782         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6783         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();
6784         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6785         check_added_monitors!(nodes[0], 1);
6786         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6787         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6788
6789         //Disconnect and Reconnect
6790         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6791         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6792         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6793         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6794         assert_eq!(reestablish_1.len(), 1);
6795         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6796         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6797         assert_eq!(reestablish_2.len(), 1);
6798         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6799         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6800         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6801         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6802
6803         //Resend HTLC
6804         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6805         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6806         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6807         check_added_monitors!(nodes[1], 1);
6808         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6809
6810         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6811
6812         assert!(nodes[1].node.list_channels().is_empty());
6813         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6814         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6815         check_added_monitors!(nodes[1], 1);
6816 }
6817
6818 #[test]
6819 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6820         //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.
6821
6822         let chanmon_cfgs = create_chanmon_cfgs(2);
6823         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6824         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6825         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6826         let logger = test_utils::TestLogger::new();
6827         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6828         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6829         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6830         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6831         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6832
6833         check_added_monitors!(nodes[0], 1);
6834         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6835         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6836
6837         let update_msg = msgs::UpdateFulfillHTLC{
6838                 channel_id: chan.2,
6839                 htlc_id: 0,
6840                 payment_preimage: our_payment_preimage,
6841         };
6842
6843         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6844
6845         assert!(nodes[0].node.list_channels().is_empty());
6846         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6847         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()));
6848         check_added_monitors!(nodes[0], 1);
6849 }
6850
6851 #[test]
6852 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6853         //BOLT 2 Requirement: until the corresponding HTLC is irrevocably committed in both sides' commitment transactions:     MUST NOT send an update_fulfill_htlc, update_fail_htlc, or update_fail_malformed_htlc.
6854
6855         let chanmon_cfgs = create_chanmon_cfgs(2);
6856         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6857         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6858         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6859         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6860         let logger = test_utils::TestLogger::new();
6861
6862         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6863         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6864         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6865         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6866         check_added_monitors!(nodes[0], 1);
6867         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6868         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6869
6870         let update_msg = msgs::UpdateFailHTLC{
6871                 channel_id: chan.2,
6872                 htlc_id: 0,
6873                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6874         };
6875
6876         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6877
6878         assert!(nodes[0].node.list_channels().is_empty());
6879         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6880         assert!(regex::Regex::new(r"Remote tried to fulfill/fail HTLC \(\d+\) before it had been committed").unwrap().is_match(err_msg.data.as_str()));
6881         check_added_monitors!(nodes[0], 1);
6882 }
6883
6884 #[test]
6885 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6886         //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.
6887
6888         let chanmon_cfgs = create_chanmon_cfgs(2);
6889         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6890         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6891         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6892         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6893         let logger = test_utils::TestLogger::new();
6894
6895         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6896         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6897         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();
6898         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6899         check_added_monitors!(nodes[0], 1);
6900         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6901         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6902         let update_msg = msgs::UpdateFailMalformedHTLC{
6903                 channel_id: chan.2,
6904                 htlc_id: 0,
6905                 sha256_of_onion: [1; 32],
6906                 failure_code: 0x8000,
6907         };
6908
6909         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6910
6911         assert!(nodes[0].node.list_channels().is_empty());
6912         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6913         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()));
6914         check_added_monitors!(nodes[0], 1);
6915 }
6916
6917 #[test]
6918 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6919         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6920
6921         let chanmon_cfgs = create_chanmon_cfgs(2);
6922         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6923         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6924         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6925         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6926
6927         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6928
6929         nodes[1].node.claim_funds(our_payment_preimage);
6930         check_added_monitors!(nodes[1], 1);
6931
6932         let events = nodes[1].node.get_and_clear_pending_msg_events();
6933         assert_eq!(events.len(), 1);
6934         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6935                 match events[0] {
6936                         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, .. } } => {
6937                                 assert!(update_add_htlcs.is_empty());
6938                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6939                                 assert!(update_fail_htlcs.is_empty());
6940                                 assert!(update_fail_malformed_htlcs.is_empty());
6941                                 assert!(update_fee.is_none());
6942                                 update_fulfill_htlcs[0].clone()
6943                         },
6944                         _ => panic!("Unexpected event"),
6945                 }
6946         };
6947
6948         update_fulfill_msg.htlc_id = 1;
6949
6950         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6951
6952         assert!(nodes[0].node.list_channels().is_empty());
6953         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6954         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6955         check_added_monitors!(nodes[0], 1);
6956 }
6957
6958 #[test]
6959 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6960         //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.
6961
6962         let chanmon_cfgs = create_chanmon_cfgs(2);
6963         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6964         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6965         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6966         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6967
6968         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6969
6970         nodes[1].node.claim_funds(our_payment_preimage);
6971         check_added_monitors!(nodes[1], 1);
6972
6973         let events = nodes[1].node.get_and_clear_pending_msg_events();
6974         assert_eq!(events.len(), 1);
6975         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6976                 match events[0] {
6977                         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, .. } } => {
6978                                 assert!(update_add_htlcs.is_empty());
6979                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6980                                 assert!(update_fail_htlcs.is_empty());
6981                                 assert!(update_fail_malformed_htlcs.is_empty());
6982                                 assert!(update_fee.is_none());
6983                                 update_fulfill_htlcs[0].clone()
6984                         },
6985                         _ => panic!("Unexpected event"),
6986                 }
6987         };
6988
6989         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6990
6991         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6992
6993         assert!(nodes[0].node.list_channels().is_empty());
6994         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6995         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6996         check_added_monitors!(nodes[0], 1);
6997 }
6998
6999 #[test]
7000 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
7001         //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.
7002
7003         let chanmon_cfgs = create_chanmon_cfgs(2);
7004         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7005         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7006         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7007         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7008         let logger = test_utils::TestLogger::new();
7009
7010         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7011         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7012         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();
7013         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7014         check_added_monitors!(nodes[0], 1);
7015
7016         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7017         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7018
7019         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7020         check_added_monitors!(nodes[1], 0);
7021         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7022
7023         let events = nodes[1].node.get_and_clear_pending_msg_events();
7024
7025         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7026                 match events[0] {
7027                         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, .. } } => {
7028                                 assert!(update_add_htlcs.is_empty());
7029                                 assert!(update_fulfill_htlcs.is_empty());
7030                                 assert!(update_fail_htlcs.is_empty());
7031                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7032                                 assert!(update_fee.is_none());
7033                                 update_fail_malformed_htlcs[0].clone()
7034                         },
7035                         _ => panic!("Unexpected event"),
7036                 }
7037         };
7038         update_msg.failure_code &= !0x8000;
7039         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7040
7041         assert!(nodes[0].node.list_channels().is_empty());
7042         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7043         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7044         check_added_monitors!(nodes[0], 1);
7045 }
7046
7047 #[test]
7048 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7049         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7050         //    * 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.
7051
7052         let chanmon_cfgs = create_chanmon_cfgs(3);
7053         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7054         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7055         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7056         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7057         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7058         let logger = test_utils::TestLogger::new();
7059
7060         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7061
7062         //First hop
7063         let mut payment_event = {
7064                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7065                 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();
7066                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7067                 check_added_monitors!(nodes[0], 1);
7068                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7069                 assert_eq!(events.len(), 1);
7070                 SendEvent::from_event(events.remove(0))
7071         };
7072         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7073         check_added_monitors!(nodes[1], 0);
7074         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7075         expect_pending_htlcs_forwardable!(nodes[1]);
7076         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7077         assert_eq!(events_2.len(), 1);
7078         check_added_monitors!(nodes[1], 1);
7079         payment_event = SendEvent::from_event(events_2.remove(0));
7080         assert_eq!(payment_event.msgs.len(), 1);
7081
7082         //Second Hop
7083         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7084         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7085         check_added_monitors!(nodes[2], 0);
7086         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7087
7088         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7089         assert_eq!(events_3.len(), 1);
7090         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7091                 match events_3[0] {
7092                         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 } } => {
7093                                 assert!(update_add_htlcs.is_empty());
7094                                 assert!(update_fulfill_htlcs.is_empty());
7095                                 assert!(update_fail_htlcs.is_empty());
7096                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7097                                 assert!(update_fee.is_none());
7098                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7099                         },
7100                         _ => panic!("Unexpected event"),
7101                 }
7102         };
7103
7104         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7105
7106         check_added_monitors!(nodes[1], 0);
7107         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7108         expect_pending_htlcs_forwardable!(nodes[1]);
7109         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7110         assert_eq!(events_4.len(), 1);
7111
7112         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7113         match events_4[0] {
7114                 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, .. } } => {
7115                         assert!(update_add_htlcs.is_empty());
7116                         assert!(update_fulfill_htlcs.is_empty());
7117                         assert_eq!(update_fail_htlcs.len(), 1);
7118                         assert!(update_fail_malformed_htlcs.is_empty());
7119                         assert!(update_fee.is_none());
7120                 },
7121                 _ => panic!("Unexpected event"),
7122         };
7123
7124         check_added_monitors!(nodes[1], 1);
7125 }
7126
7127 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7128         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7129         // 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
7130         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7131
7132         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7133         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7134         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7135         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7136         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7137         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7138
7139         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7140
7141         // We route 2 dust-HTLCs between A and B
7142         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7143         let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7144         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7145
7146         // Cache one local commitment tx as previous
7147         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7148
7149         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7150         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7151         check_added_monitors!(nodes[1], 0);
7152         expect_pending_htlcs_forwardable!(nodes[1]);
7153         check_added_monitors!(nodes[1], 1);
7154
7155         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7156         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7157         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7158         check_added_monitors!(nodes[0], 1);
7159
7160         // Cache one local commitment tx as lastest
7161         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7162
7163         let events = nodes[0].node.get_and_clear_pending_msg_events();
7164         match events[0] {
7165                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7166                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7167                 },
7168                 _ => panic!("Unexpected event"),
7169         }
7170         match events[1] {
7171                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7172                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7173                 },
7174                 _ => panic!("Unexpected event"),
7175         }
7176
7177         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7178         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7179         if announce_latest {
7180                 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7181         } else {
7182                 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7183         }
7184
7185         check_closed_broadcast!(nodes[0], true);
7186         check_added_monitors!(nodes[0], 1);
7187
7188         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7189         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7190         let events = nodes[0].node.get_and_clear_pending_events();
7191         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7192         assert_eq!(events.len(), 2);
7193         let mut first_failed = false;
7194         for event in events {
7195                 match event {
7196                         Event::PaymentFailed { payment_hash, .. } => {
7197                                 if payment_hash == payment_hash_1 {
7198                                         assert!(!first_failed);
7199                                         first_failed = true;
7200                                 } else {
7201                                         assert_eq!(payment_hash, payment_hash_2);
7202                                 }
7203                         }
7204                         _ => panic!("Unexpected event"),
7205                 }
7206         }
7207 }
7208
7209 #[test]
7210 fn test_failure_delay_dust_htlc_local_commitment() {
7211         do_test_failure_delay_dust_htlc_local_commitment(true);
7212         do_test_failure_delay_dust_htlc_local_commitment(false);
7213 }
7214
7215 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7216         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7217         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7218         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7219         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7220         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7221         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7222
7223         let chanmon_cfgs = create_chanmon_cfgs(3);
7224         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7225         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7226         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7227         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7228
7229         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7230
7231         let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7232         let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7233
7234         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7235         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7236
7237         // We revoked bs_commitment_tx
7238         if revoked {
7239                 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7240                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7241         }
7242
7243         let mut timeout_tx = Vec::new();
7244         if local {
7245                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7246                 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7247                 check_closed_broadcast!(nodes[0], true);
7248                 check_added_monitors!(nodes[0], 1);
7249                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7250                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7251                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7252                 expect_payment_failed!(nodes[0], dust_hash, true);
7253                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7254                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7255                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7256                 mine_transaction(&nodes[0], &timeout_tx[0]);
7257                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7258                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7259         } else {
7260                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7261                 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7262                 check_closed_broadcast!(nodes[0], true);
7263                 check_added_monitors!(nodes[0], 1);
7264                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7265                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7266                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7267                 if !revoked {
7268                         expect_payment_failed!(nodes[0], dust_hash, true);
7269                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7270                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7271                         mine_transaction(&nodes[0], &timeout_tx[0]);
7272                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7273                         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7274                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7275                 } else {
7276                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7277                         // commitment tx
7278                         let events = nodes[0].node.get_and_clear_pending_events();
7279                         assert_eq!(events.len(), 2);
7280                         let first;
7281                         match events[0] {
7282                                 Event::PaymentFailed { payment_hash, .. } => {
7283                                         if payment_hash == dust_hash { first = true; }
7284                                         else { first = false; }
7285                                 },
7286                                 _ => panic!("Unexpected event"),
7287                         }
7288                         match events[1] {
7289                                 Event::PaymentFailed { payment_hash, .. } => {
7290                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7291                                         else { assert_eq!(payment_hash, dust_hash); }
7292                                 },
7293                                 _ => panic!("Unexpected event"),
7294                         }
7295                 }
7296         }
7297 }
7298
7299 #[test]
7300 fn test_sweep_outbound_htlc_failure_update() {
7301         do_test_sweep_outbound_htlc_failure_update(false, true);
7302         do_test_sweep_outbound_htlc_failure_update(false, false);
7303         do_test_sweep_outbound_htlc_failure_update(true, false);
7304 }
7305
7306 #[test]
7307 fn test_upfront_shutdown_script() {
7308         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7309         // enforce it at shutdown message
7310
7311         let mut config = UserConfig::default();
7312         config.channel_options.announced_channel = true;
7313         config.peer_channel_config_limits.force_announced_channel_preference = false;
7314         config.channel_options.commit_upfront_shutdown_pubkey = false;
7315         let user_cfgs = [None, Some(config), None];
7316         let chanmon_cfgs = create_chanmon_cfgs(3);
7317         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7318         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7319         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7320
7321         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7322         let flags = InitFeatures::known();
7323         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7324         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7325         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7326         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7327         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7328         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7329     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()));
7330         check_added_monitors!(nodes[2], 1);
7331
7332         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7333         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7334         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7335         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7336         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7337         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7338         let events = nodes[2].node.get_and_clear_pending_msg_events();
7339         assert_eq!(events.len(), 1);
7340         match events[0] {
7341                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7342                 _ => panic!("Unexpected event"),
7343         }
7344
7345         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7346         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7347         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7348         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7349         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7350         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7351         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7352         let events = nodes[1].node.get_and_clear_pending_msg_events();
7353         assert_eq!(events.len(), 1);
7354         match events[0] {
7355                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7356                 _ => panic!("Unexpected event"),
7357         }
7358
7359         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7360         // channel smoothly, opt-out is from channel initiator here
7361         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7362         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7363         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7364         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7365         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7366         let events = nodes[0].node.get_and_clear_pending_msg_events();
7367         assert_eq!(events.len(), 1);
7368         match events[0] {
7369                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7370                 _ => panic!("Unexpected event"),
7371         }
7372
7373         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7374         //// channel smoothly
7375         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7376         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7377         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7378         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7379         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7380         let events = nodes[0].node.get_and_clear_pending_msg_events();
7381         assert_eq!(events.len(), 2);
7382         match events[0] {
7383                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7384                 _ => panic!("Unexpected event"),
7385         }
7386         match events[1] {
7387                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7388                 _ => panic!("Unexpected event"),
7389         }
7390 }
7391
7392 #[test]
7393 fn test_upfront_shutdown_script_unsupport_segwit() {
7394         // We test that channel is closed early
7395         // if a segwit program is passed as upfront shutdown script,
7396         // but the peer does not support segwit.
7397         let chanmon_cfgs = create_chanmon_cfgs(2);
7398         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7399         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7400         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7401
7402         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7403
7404         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7405         open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(16)
7406                 .push_slice(&[0, 0])
7407                 .into_script());
7408
7409         let features = InitFeatures::known().clear_shutdown_anysegwit();
7410         nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), features, &open_channel);
7411
7412         let events = nodes[0].node.get_and_clear_pending_msg_events();
7413         assert_eq!(events.len(), 1);
7414         match events[0] {
7415                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7416                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
7417                         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));
7418                 },
7419                 _ => panic!("Unexpected event"),
7420         }
7421 }
7422
7423 #[test]
7424 fn test_shutdown_script_any_segwit_allowed() {
7425         let mut config = UserConfig::default();
7426         config.channel_options.announced_channel = true;
7427         config.peer_channel_config_limits.force_announced_channel_preference = false;
7428         config.channel_options.commit_upfront_shutdown_pubkey = false;
7429         let user_cfgs = [None, Some(config), None];
7430         let chanmon_cfgs = create_chanmon_cfgs(3);
7431         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7432         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7433         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7434
7435         //// We test if the remote peer accepts opt_shutdown_anysegwit, a witness program can be used on shutdown
7436         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7437         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7438         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7439         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7440                 .push_slice(&[0, 0])
7441                 .into_script();
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_shutdown_script_any_segwit_not_allowed() {
7457         let mut config = UserConfig::default();
7458         config.channel_options.announced_channel = true;
7459         config.peer_channel_config_limits.force_announced_channel_preference = false;
7460         config.channel_options.commit_upfront_shutdown_pubkey = false;
7461         let user_cfgs = [None, Some(config), None];
7462         let chanmon_cfgs = create_chanmon_cfgs(3);
7463         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7464         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7465         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7466
7467         //// We test that if the remote peer does not accept opt_shutdown_anysegwit, the witness program cannot be used on shutdown
7468         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7469         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7470         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7471         // Make an any segwit version script
7472         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7473                 .push_slice(&[0, 0])
7474                 .into_script();
7475         let flags_no = InitFeatures::known().clear_shutdown_anysegwit();
7476         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &flags_no, &node_0_shutdown);
7477         let events = nodes[0].node.get_and_clear_pending_msg_events();
7478         assert_eq!(events.len(), 2);
7479         match events[1] {
7480                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7481                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7482                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020000) from remote peer".to_owned())
7483                 },
7484                 _ => panic!("Unexpected event"),
7485         }
7486         check_added_monitors!(nodes[0], 1);
7487 }
7488
7489 #[test]
7490 fn test_shutdown_script_segwit_but_not_anysegwit() {
7491         let mut config = UserConfig::default();
7492         config.channel_options.announced_channel = true;
7493         config.peer_channel_config_limits.force_announced_channel_preference = false;
7494         config.channel_options.commit_upfront_shutdown_pubkey = false;
7495         let user_cfgs = [None, Some(config), None];
7496         let chanmon_cfgs = create_chanmon_cfgs(3);
7497         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7498         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7499         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7500
7501         //// We test that if shutdown any segwit is supported and we send a witness script with 0 version, this is not accepted
7502         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7503         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7504         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7505         // Make a segwit script that is not a valid as any segwit
7506         node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7507                 .push_slice(&[0, 0])
7508                 .into_script();
7509         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7510         let events = nodes[0].node.get_and_clear_pending_msg_events();
7511         assert_eq!(events.len(), 2);
7512         match events[1] {
7513                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7514                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7515                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7516                 },
7517                 _ => panic!("Unexpected event"),
7518         }
7519         check_added_monitors!(nodes[0], 1);
7520 }
7521
7522 #[test]
7523 fn test_user_configurable_csv_delay() {
7524         // We test our channel constructors yield errors when we pass them absurd csv delay
7525
7526         let mut low_our_to_self_config = UserConfig::default();
7527         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7528         let mut high_their_to_self_config = UserConfig::default();
7529         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7530         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7531         let chanmon_cfgs = create_chanmon_cfgs(2);
7532         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7533         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7534         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7535
7536         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7537         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) {
7538                 match error {
7539                         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())); },
7540                         _ => panic!("Unexpected event"),
7541                 }
7542         } else { assert!(false) }
7543
7544         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7545         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7546         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7547         open_channel.to_self_delay = 200;
7548         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) {
7549                 match error {
7550                         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()));  },
7551                         _ => panic!("Unexpected event"),
7552                 }
7553         } else { assert!(false); }
7554
7555         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7556         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7557         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()));
7558         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7559         accept_channel.to_self_delay = 200;
7560         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7561         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7562                 match action {
7563                         &ErrorAction::SendErrorMessage { ref msg } => {
7564                                 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()));
7565                         },
7566                         _ => { assert!(false); }
7567                 }
7568         } else { assert!(false); }
7569
7570         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7571         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7572         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7573         open_channel.to_self_delay = 200;
7574         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) {
7575                 match error {
7576                         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())); },
7577                         _ => panic!("Unexpected event"),
7578                 }
7579         } else { assert!(false); }
7580 }
7581
7582 #[test]
7583 fn test_data_loss_protect() {
7584         // We want to be sure that :
7585         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7586         //   (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7587         // * we close channel in case of detecting other being fallen behind
7588         // * we are able to claim our own outputs thanks to to_remote being static
7589         // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7590         let persister;
7591         let logger;
7592         let fee_estimator;
7593         let tx_broadcaster;
7594         let chain_source;
7595         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7596         // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7597         // during signing due to revoked tx
7598         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7599         let keys_manager = &chanmon_cfgs[0].keys_manager;
7600         let monitor;
7601         let node_state_0;
7602         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7603         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7604         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7605
7606         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7607
7608         // Cache node A state before any channel update
7609         let previous_node_state = nodes[0].node.encode();
7610         let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7611         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7612
7613         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7614         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7615
7616         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7617         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7618
7619         // Restore node A from previous state
7620         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7621         let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7622         chain_source = test_utils::TestChainSource::new(Network::Testnet);
7623         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
7624         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7625         persister = test_utils::TestPersister::new();
7626         monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7627         node_state_0 = {
7628                 let mut channel_monitors = HashMap::new();
7629                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7630                 <(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 {
7631                         keys_manager: keys_manager,
7632                         fee_estimator: &fee_estimator,
7633                         chain_monitor: &monitor,
7634                         logger: &logger,
7635                         tx_broadcaster: &tx_broadcaster,
7636                         default_config: UserConfig::default(),
7637                         channel_monitors,
7638                 }).unwrap().1
7639         };
7640         nodes[0].node = &node_state_0;
7641         assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7642         nodes[0].chain_monitor = &monitor;
7643         nodes[0].chain_source = &chain_source;
7644
7645         check_added_monitors!(nodes[0], 1);
7646
7647         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7648         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7649
7650         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7651
7652         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7653         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7654         check_added_monitors!(nodes[0], 1);
7655
7656         {
7657                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7658                 assert_eq!(node_txn.len(), 0);
7659         }
7660
7661         let mut reestablish_1 = Vec::with_capacity(1);
7662         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7663                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7664                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7665                         reestablish_1.push(msg.clone());
7666                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7667                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7668                         match action {
7669                                 &ErrorAction::SendErrorMessage { ref msg } => {
7670                                         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");
7671                                 },
7672                                 _ => panic!("Unexpected event!"),
7673                         }
7674                 } else {
7675                         panic!("Unexpected event")
7676                 }
7677         }
7678
7679         // Check we close channel detecting A is fallen-behind
7680         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7681         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7682         check_added_monitors!(nodes[1], 1);
7683
7684
7685         // Check A is able to claim to_remote output
7686         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7687         assert_eq!(node_txn.len(), 1);
7688         check_spends!(node_txn[0], chan.3);
7689         assert_eq!(node_txn[0].output.len(), 2);
7690         mine_transaction(&nodes[0], &node_txn[0]);
7691         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7692         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 1000000);
7693         assert_eq!(spend_txn.len(), 1);
7694         check_spends!(spend_txn[0], node_txn[0]);
7695 }
7696
7697 #[test]
7698 fn test_check_htlc_underpaying() {
7699         // Send payment through A -> B but A is maliciously
7700         // sending a probe payment (i.e less than expected value0
7701         // to B, B should refuse payment.
7702
7703         let chanmon_cfgs = create_chanmon_cfgs(2);
7704         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7705         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7706         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7707
7708         // Create some initial channels
7709         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7710
7711         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();
7712         let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7713         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7714         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7715         check_added_monitors!(nodes[0], 1);
7716
7717         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7718         assert_eq!(events.len(), 1);
7719         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7720         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7721         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7722
7723         // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7724         // and then will wait a second random delay before failing the HTLC back:
7725         expect_pending_htlcs_forwardable!(nodes[1]);
7726         expect_pending_htlcs_forwardable!(nodes[1]);
7727
7728         // Node 3 is expecting payment of 100_000 but received 10_000,
7729         // it should fail htlc like we didn't know the preimage.
7730         nodes[1].node.process_pending_htlc_forwards();
7731
7732         let events = nodes[1].node.get_and_clear_pending_msg_events();
7733         assert_eq!(events.len(), 1);
7734         let (update_fail_htlc, commitment_signed) = match events[0] {
7735                 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 } } => {
7736                         assert!(update_add_htlcs.is_empty());
7737                         assert!(update_fulfill_htlcs.is_empty());
7738                         assert_eq!(update_fail_htlcs.len(), 1);
7739                         assert!(update_fail_malformed_htlcs.is_empty());
7740                         assert!(update_fee.is_none());
7741                         (update_fail_htlcs[0].clone(), commitment_signed)
7742                 },
7743                 _ => panic!("Unexpected event"),
7744         };
7745         check_added_monitors!(nodes[1], 1);
7746
7747         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7748         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7749
7750         // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7751         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7752         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7753         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7754 }
7755
7756 #[test]
7757 fn test_announce_disable_channels() {
7758         // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7759         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7760
7761         let chanmon_cfgs = create_chanmon_cfgs(2);
7762         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7763         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7764         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7765
7766         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7767         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7768         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7769
7770         // Disconnect peers
7771         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7772         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7773
7774         nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7775         nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7776         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7777         assert_eq!(msg_events.len(), 3);
7778         let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7779         for e in msg_events {
7780                 match e {
7781                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7782                                 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7783                                 // Check that each channel gets updated exactly once
7784                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7785                                         panic!("Generated ChannelUpdate for wrong chan!");
7786                                 }
7787                         },
7788                         _ => panic!("Unexpected event"),
7789                 }
7790         }
7791         // Reconnect peers
7792         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7793         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7794         assert_eq!(reestablish_1.len(), 3);
7795         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7796         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7797         assert_eq!(reestablish_2.len(), 3);
7798
7799         // Reestablish chan_1
7800         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7801         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7802         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7803         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7804         // Reestablish chan_2
7805         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7806         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7807         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7808         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7809         // Reestablish chan_3
7810         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7811         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7812         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7813         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7814
7815         nodes[0].node.timer_tick_occurred();
7816         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7817         nodes[0].node.timer_tick_occurred();
7818         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7819         assert_eq!(msg_events.len(), 3);
7820         chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7821         for e in msg_events {
7822                 match e {
7823                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7824                                 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7825                                 // Check that each channel gets updated exactly once
7826                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7827                                         panic!("Generated ChannelUpdate for wrong chan!");
7828                                 }
7829                         },
7830                         _ => panic!("Unexpected event"),
7831                 }
7832         }
7833 }
7834
7835 #[test]
7836 fn test_bump_penalty_txn_on_revoked_commitment() {
7837         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7838         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7839
7840         let chanmon_cfgs = create_chanmon_cfgs(2);
7841         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7842         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7843         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7844
7845         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7846         let logger = test_utils::TestLogger::new();
7847
7848         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7849         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7850         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();
7851         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7852
7853         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7854         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7855         assert_eq!(revoked_txn[0].output.len(), 4);
7856         assert_eq!(revoked_txn[0].input.len(), 1);
7857         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7858         let revoked_txid = revoked_txn[0].txid();
7859
7860         let mut penalty_sum = 0;
7861         for outp in revoked_txn[0].output.iter() {
7862                 if outp.script_pubkey.is_v0_p2wsh() {
7863                         penalty_sum += outp.value;
7864                 }
7865         }
7866
7867         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7868         let header_114 = connect_blocks(&nodes[1], 14);
7869
7870         // Actually revoke tx by claiming a HTLC
7871         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7872         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7873         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7874         check_added_monitors!(nodes[1], 1);
7875
7876         // One or more justice tx should have been broadcast, check it
7877         let penalty_1;
7878         let feerate_1;
7879         {
7880                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7881                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7882                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7883                 assert_eq!(node_txn[0].output.len(), 1);
7884                 check_spends!(node_txn[0], revoked_txn[0]);
7885                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7886                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7887                 penalty_1 = node_txn[0].txid();
7888                 node_txn.clear();
7889         };
7890
7891         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7892         connect_blocks(&nodes[1], 15);
7893         let mut penalty_2 = penalty_1;
7894         let mut feerate_2 = 0;
7895         {
7896                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7897                 assert_eq!(node_txn.len(), 1);
7898                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7899                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7900                         assert_eq!(node_txn[0].output.len(), 1);
7901                         check_spends!(node_txn[0], revoked_txn[0]);
7902                         penalty_2 = node_txn[0].txid();
7903                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7904                         assert_ne!(penalty_2, penalty_1);
7905                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7906                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7907                         // Verify 25% bump heuristic
7908                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7909                         node_txn.clear();
7910                 }
7911         }
7912         assert_ne!(feerate_2, 0);
7913
7914         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7915         connect_blocks(&nodes[1], 1);
7916         let penalty_3;
7917         let mut feerate_3 = 0;
7918         {
7919                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7920                 assert_eq!(node_txn.len(), 1);
7921                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7922                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7923                         assert_eq!(node_txn[0].output.len(), 1);
7924                         check_spends!(node_txn[0], revoked_txn[0]);
7925                         penalty_3 = node_txn[0].txid();
7926                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7927                         assert_ne!(penalty_3, penalty_2);
7928                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7929                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7930                         // Verify 25% bump heuristic
7931                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7932                         node_txn.clear();
7933                 }
7934         }
7935         assert_ne!(feerate_3, 0);
7936
7937         nodes[1].node.get_and_clear_pending_events();
7938         nodes[1].node.get_and_clear_pending_msg_events();
7939 }
7940
7941 #[test]
7942 fn test_bump_penalty_txn_on_revoked_htlcs() {
7943         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7944         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7945
7946         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7947         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
7948         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7949         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7950         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7951
7952         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7953         // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
7954         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
7955                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
7956         let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
7957         let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph.read().unwrap(),
7958                 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
7959         send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
7960
7961         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7962         assert_eq!(revoked_local_txn[0].input.len(), 1);
7963         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7964
7965         // Revoke local commitment tx
7966         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7967
7968         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7969         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7970         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
7971         check_closed_broadcast!(nodes[1], true);
7972         check_added_monitors!(nodes[1], 1);
7973
7974         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7975         assert_eq!(revoked_htlc_txn.len(), 4);
7976         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7977                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7978                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7979                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7980                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7981                 assert_eq!(revoked_htlc_txn[1].output.len(), 1);
7982                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7983         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7984                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7985                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7986                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7987                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7988                 assert_eq!(revoked_htlc_txn[0].output.len(), 1);
7989                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7990         }
7991
7992         // Broadcast set of revoked txn on A
7993         let hash_128 = connect_blocks(&nodes[0], 40);
7994         let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7995         connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
7996         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7997         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] });
7998         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7999         let first;
8000         let feerate_1;
8001         let penalty_txn;
8002         {
8003                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8004                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
8005                 // Verify claim tx are spending revoked HTLC txn
8006
8007                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
8008                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
8009                 // which are included in the same block (they are broadcasted because we scan the
8010                 // transactions linearly and generate claims as we go, they likely should be removed in the
8011                 // future).
8012                 assert_eq!(node_txn[0].input.len(), 1);
8013                 check_spends!(node_txn[0], revoked_local_txn[0]);
8014                 assert_eq!(node_txn[1].input.len(), 1);
8015                 check_spends!(node_txn[1], revoked_local_txn[0]);
8016                 assert_eq!(node_txn[2].input.len(), 1);
8017                 check_spends!(node_txn[2], revoked_local_txn[0]);
8018
8019                 // Each of the three justice transactions claim a separate (single) output of the three
8020                 // available, which we check here:
8021                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
8022                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
8023                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
8024
8025                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8026                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
8027
8028                 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
8029                 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
8030                 // a remote commitment tx has already been confirmed).
8031                 check_spends!(node_txn[3], chan.3);
8032
8033                 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
8034                 // output, checked above).
8035                 assert_eq!(node_txn[4].input.len(), 2);
8036                 assert_eq!(node_txn[4].output.len(), 1);
8037                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
8038
8039                 first = node_txn[4].txid();
8040                 // Store both feerates for later comparison
8041                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
8042                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
8043                 penalty_txn = vec![node_txn[2].clone()];
8044                 node_txn.clear();
8045         }
8046
8047         // Connect one more block to see if bumped penalty are issued for HTLC txn
8048         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8049         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8050         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8051         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
8052         {
8053                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8054                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
8055
8056                 check_spends!(node_txn[0], revoked_local_txn[0]);
8057                 check_spends!(node_txn[1], revoked_local_txn[0]);
8058                 // Note that these are both bogus - they spend outputs already claimed in block 129:
8059                 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output  {
8060                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
8061                 } else {
8062                         assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
8063                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8064                 }
8065
8066                 node_txn.clear();
8067         };
8068
8069         // Few more blocks to confirm penalty txn
8070         connect_blocks(&nodes[0], 4);
8071         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8072         let header_144 = connect_blocks(&nodes[0], 9);
8073         let node_txn = {
8074                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8075                 assert_eq!(node_txn.len(), 1);
8076
8077                 assert_eq!(node_txn[0].input.len(), 2);
8078                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
8079                 // Verify bumped tx is different and 25% bump heuristic
8080                 assert_ne!(first, node_txn[0].txid());
8081                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
8082                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8083                 assert!(feerate_2 * 100 > feerate_1 * 125);
8084                 let txn = vec![node_txn[0].clone()];
8085                 node_txn.clear();
8086                 txn
8087         };
8088         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8089         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8090         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
8091         connect_blocks(&nodes[0], 20);
8092         {
8093                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8094                 // We verify than no new transaction has been broadcast because previously
8095                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8096                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8097                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8098                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8099                 // up bumped justice generation.
8100                 assert_eq!(node_txn.len(), 0);
8101                 node_txn.clear();
8102         }
8103         check_closed_broadcast!(nodes[0], true);
8104         check_added_monitors!(nodes[0], 1);
8105 }
8106
8107 #[test]
8108 fn test_bump_penalty_txn_on_remote_commitment() {
8109         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8110         // we're able to claim outputs on remote commitment transaction before timelocks expiration
8111
8112         // Create 2 HTLCs
8113         // Provide preimage for one
8114         // Check aggregation
8115
8116         let chanmon_cfgs = create_chanmon_cfgs(2);
8117         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8118         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8119         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8120
8121         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8122         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8123         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8124
8125         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8126         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8127         assert_eq!(remote_txn[0].output.len(), 4);
8128         assert_eq!(remote_txn[0].input.len(), 1);
8129         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8130
8131         // Claim a HTLC without revocation (provide B monitor with preimage)
8132         nodes[1].node.claim_funds(payment_preimage);
8133         mine_transaction(&nodes[1], &remote_txn[0]);
8134         check_added_monitors!(nodes[1], 2);
8135
8136         // One or more claim tx should have been broadcast, check it
8137         let timeout;
8138         let preimage;
8139         let feerate_timeout;
8140         let feerate_preimage;
8141         {
8142                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8143                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
8144                 assert_eq!(node_txn[0].input.len(), 1);
8145                 assert_eq!(node_txn[1].input.len(), 1);
8146                 check_spends!(node_txn[0], remote_txn[0]);
8147                 check_spends!(node_txn[1], remote_txn[0]);
8148                 check_spends!(node_txn[2], chan.3);
8149                 check_spends!(node_txn[3], node_txn[2]);
8150                 check_spends!(node_txn[4], node_txn[2]);
8151                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8152                         timeout = node_txn[0].txid();
8153                         let index = node_txn[0].input[0].previous_output.vout;
8154                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8155                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
8156
8157                         preimage = node_txn[1].txid();
8158                         let index = node_txn[1].input[0].previous_output.vout;
8159                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8160                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
8161                 } else {
8162                         timeout = node_txn[1].txid();
8163                         let index = node_txn[1].input[0].previous_output.vout;
8164                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8165                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
8166
8167                         preimage = node_txn[0].txid();
8168                         let index = node_txn[0].input[0].previous_output.vout;
8169                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8170                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8171                 }
8172                 node_txn.clear();
8173         };
8174         assert_ne!(feerate_timeout, 0);
8175         assert_ne!(feerate_preimage, 0);
8176
8177         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8178         connect_blocks(&nodes[1], 15);
8179         {
8180                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8181                 assert_eq!(node_txn.len(), 2);
8182                 assert_eq!(node_txn[0].input.len(), 1);
8183                 assert_eq!(node_txn[1].input.len(), 1);
8184                 check_spends!(node_txn[0], remote_txn[0]);
8185                 check_spends!(node_txn[1], remote_txn[0]);
8186                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8187                         let index = node_txn[0].input[0].previous_output.vout;
8188                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8189                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8190                         assert!(new_feerate * 100 > feerate_timeout * 125);
8191                         assert_ne!(timeout, node_txn[0].txid());
8192
8193                         let index = node_txn[1].input[0].previous_output.vout;
8194                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8195                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8196                         assert!(new_feerate * 100 > feerate_preimage * 125);
8197                         assert_ne!(preimage, node_txn[1].txid());
8198                 } else {
8199                         let index = node_txn[1].input[0].previous_output.vout;
8200                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8201                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8202                         assert!(new_feerate * 100 > feerate_timeout * 125);
8203                         assert_ne!(timeout, node_txn[1].txid());
8204
8205                         let index = node_txn[0].input[0].previous_output.vout;
8206                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8207                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8208                         assert!(new_feerate * 100 > feerate_preimage * 125);
8209                         assert_ne!(preimage, node_txn[0].txid());
8210                 }
8211                 node_txn.clear();
8212         }
8213
8214         nodes[1].node.get_and_clear_pending_events();
8215         nodes[1].node.get_and_clear_pending_msg_events();
8216 }
8217
8218 #[test]
8219 fn test_counterparty_raa_skip_no_crash() {
8220         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8221         // commitment transaction, we would have happily carried on and provided them the next
8222         // commitment transaction based on one RAA forward. This would probably eventually have led to
8223         // channel closure, but it would not have resulted in funds loss. Still, our
8224         // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
8225         // check simply that the channel is closed in response to such an RAA, but don't check whether
8226         // we decide to punish our counterparty for revoking their funds (as we don't currently
8227         // implement that).
8228         let chanmon_cfgs = create_chanmon_cfgs(2);
8229         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8230         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8231         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8232         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8233
8234         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8235         let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8236         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8237         let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8238         // Must revoke without gaps
8239         keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8240         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8241                 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8242
8243         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8244                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8245         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8246         check_added_monitors!(nodes[1], 1);
8247 }
8248
8249 #[test]
8250 fn test_bump_txn_sanitize_tracking_maps() {
8251         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8252         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8253
8254         let chanmon_cfgs = create_chanmon_cfgs(2);
8255         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8256         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8257         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8258
8259         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8260         // Lock HTLC in both directions
8261         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8262         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8263
8264         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8265         assert_eq!(revoked_local_txn[0].input.len(), 1);
8266         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8267
8268         // Revoke local commitment tx
8269         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8270
8271         // Broadcast set of revoked txn on A
8272         connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8273         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8274         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8275
8276         mine_transaction(&nodes[0], &revoked_local_txn[0]);
8277         check_closed_broadcast!(nodes[0], true);
8278         check_added_monitors!(nodes[0], 1);
8279         let penalty_txn = {
8280                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8281                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8282                 check_spends!(node_txn[0], revoked_local_txn[0]);
8283                 check_spends!(node_txn[1], revoked_local_txn[0]);
8284                 check_spends!(node_txn[2], revoked_local_txn[0]);
8285                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8286                 node_txn.clear();
8287                 penalty_txn
8288         };
8289         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8290         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8291         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8292         {
8293                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8294                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8295                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8296                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8297                 }
8298         }
8299 }
8300
8301 #[test]
8302 fn test_override_channel_config() {
8303         let chanmon_cfgs = create_chanmon_cfgs(2);
8304         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8305         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8306         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8307
8308         // Node0 initiates a channel to node1 using the override config.
8309         let mut override_config = UserConfig::default();
8310         override_config.own_channel_config.our_to_self_delay = 200;
8311
8312         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8313
8314         // Assert the channel created by node0 is using the override config.
8315         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8316         assert_eq!(res.channel_flags, 0);
8317         assert_eq!(res.to_self_delay, 200);
8318 }
8319
8320 #[test]
8321 fn test_override_0msat_htlc_minimum() {
8322         let mut zero_config = UserConfig::default();
8323         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8324         let chanmon_cfgs = create_chanmon_cfgs(2);
8325         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8326         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8327         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8328
8329         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8330         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8331         assert_eq!(res.htlc_minimum_msat, 1);
8332
8333         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8334         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8335         assert_eq!(res.htlc_minimum_msat, 1);
8336 }
8337
8338 #[test]
8339 fn test_simple_mpp() {
8340         // Simple test of sending a multi-path payment.
8341         let chanmon_cfgs = create_chanmon_cfgs(4);
8342         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8343         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8344         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8345
8346         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8347         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8348         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8349         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8350         let logger = test_utils::TestLogger::new();
8351
8352         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8353         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8354         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();
8355         let path = route.paths[0].clone();
8356         route.paths.push(path);
8357         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8358         route.paths[0][0].short_channel_id = chan_1_id;
8359         route.paths[0][1].short_channel_id = chan_3_id;
8360         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8361         route.paths[1][0].short_channel_id = chan_2_id;
8362         route.paths[1][1].short_channel_id = chan_4_id;
8363         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8364         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8365 }
8366
8367 #[test]
8368 fn test_preimage_storage() {
8369         // Simple test of payment preimage storage allowing no client-side storage to claim payments
8370         let chanmon_cfgs = create_chanmon_cfgs(2);
8371         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8372         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8373         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8374
8375         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8376
8377         {
8378                 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8379
8380                 let logger = test_utils::TestLogger::new();
8381                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8382                 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();
8383                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8384                 check_added_monitors!(nodes[0], 1);
8385                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8386                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8387                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8388                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8389         }
8390         // Note that after leaving the above scope we have no knowledge of any arguments or return
8391         // values from previous calls.
8392         expect_pending_htlcs_forwardable!(nodes[1]);
8393         let events = nodes[1].node.get_and_clear_pending_events();
8394         assert_eq!(events.len(), 1);
8395         match events[0] {
8396                 Event::PaymentReceived { payment_preimage, user_payment_id, .. } => {
8397                         assert_eq!(user_payment_id, 42);
8398                         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8399                 },
8400                 _ => panic!("Unexpected event"),
8401         }
8402 }
8403
8404 #[test]
8405 fn test_secret_timeout() {
8406         // Simple test of payment secret storage time outs
8407         let chanmon_cfgs = create_chanmon_cfgs(2);
8408         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8409         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8410         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8411
8412         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8413
8414         let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8415
8416         // We should fail to register the same payment hash twice, at least until we've connected a
8417         // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8418         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8419                 assert_eq!(err, "Duplicate payment hash");
8420         } else { panic!(); }
8421         let mut block = Block {
8422                 header: BlockHeader {
8423                         version: 0x2000000,
8424                         prev_blockhash: nodes[1].blocks.borrow().last().unwrap().0.block_hash(),
8425                         merkle_root: Default::default(),
8426                         time: nodes[1].blocks.borrow().len() as u32 + 7200, bits: 42, nonce: 42 },
8427                 txdata: vec![],
8428         };
8429         connect_block(&nodes[1], &block);
8430         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8431                 assert_eq!(err, "Duplicate payment hash");
8432         } else { panic!(); }
8433
8434         // If we then connect the second block, we should be able to register the same payment hash
8435         // again with a different user_payment_id (this time getting a new payment secret).
8436         block.header.prev_blockhash = block.header.block_hash();
8437         block.header.time += 1;
8438         connect_block(&nodes[1], &block);
8439         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8440         assert_ne!(payment_secret_1, our_payment_secret);
8441
8442         {
8443                 let logger = test_utils::TestLogger::new();
8444                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8445                 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();
8446                 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8447                 check_added_monitors!(nodes[0], 1);
8448                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8449                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8450                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8451                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8452         }
8453         // Note that after leaving the above scope we have no knowledge of any arguments or return
8454         // values from previous calls.
8455         expect_pending_htlcs_forwardable!(nodes[1]);
8456         let events = nodes[1].node.get_and_clear_pending_events();
8457         assert_eq!(events.len(), 1);
8458         match events[0] {
8459                 Event::PaymentReceived { payment_preimage, payment_secret, user_payment_id, .. } => {
8460                         assert!(payment_preimage.is_none());
8461                         assert_eq!(user_payment_id, 42);
8462                         assert_eq!(payment_secret, our_payment_secret);
8463                         // We don't actually have the payment preimage with which to claim this payment!
8464                 },
8465                 _ => panic!("Unexpected event"),
8466         }
8467 }
8468
8469 #[test]
8470 fn test_bad_secret_hash() {
8471         // Simple test of unregistered payment hash/invalid payment secret handling
8472         let chanmon_cfgs = create_chanmon_cfgs(2);
8473         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8474         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8475         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8476
8477         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8478
8479         let random_payment_hash = PaymentHash([42; 32]);
8480         let random_payment_secret = PaymentSecret([43; 32]);
8481         let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8482
8483         let logger = test_utils::TestLogger::new();
8484         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8485         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();
8486
8487         // All the below cases should end up being handled exactly identically, so we macro the
8488         // resulting events.
8489         macro_rules! handle_unknown_invalid_payment_data {
8490                 () => {
8491                         check_added_monitors!(nodes[0], 1);
8492                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8493                         let payment_event = SendEvent::from_event(events.pop().unwrap());
8494                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8495                         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8496
8497                         // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8498                         // again to process the pending backwards-failure of the HTLC
8499                         expect_pending_htlcs_forwardable!(nodes[1]);
8500                         expect_pending_htlcs_forwardable!(nodes[1]);
8501                         check_added_monitors!(nodes[1], 1);
8502
8503                         // We should fail the payment back
8504                         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8505                         match events.pop().unwrap() {
8506                                 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8507                                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8508                                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8509                                 },
8510                                 _ => panic!("Unexpected event"),
8511                         }
8512                 }
8513         }
8514
8515         let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8516         // Error data is the HTLC value (100,000) and current block height
8517         let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8518
8519         // Send a payment with the right payment hash but the wrong payment secret
8520         nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8521         handle_unknown_invalid_payment_data!();
8522         expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8523
8524         // Send a payment with a random payment hash, but the right payment secret
8525         nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8526         handle_unknown_invalid_payment_data!();
8527         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8528
8529         // Send a payment with a random payment hash and random payment secret
8530         nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8531         handle_unknown_invalid_payment_data!();
8532         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8533 }
8534
8535 #[test]
8536 fn test_update_err_monitor_lockdown() {
8537         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8538         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8539         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8540         //
8541         // This scenario may happen in a watchtower setup, where watchtower process a block height
8542         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8543         // commitment at same time.
8544
8545         let chanmon_cfgs = create_chanmon_cfgs(2);
8546         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8547         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8548         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8549
8550         // Create some initial channel
8551         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8552         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8553
8554         // Rebalance the network to generate htlc in the two directions
8555         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8556
8557         // Route a HTLC from node 0 to node 1 (but don't settle)
8558         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8559
8560         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8561         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8562         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8563         let persister = test_utils::TestPersister::new();
8564         let watchtower = {
8565                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8566                 let monitor = monitors.get(&outpoint).unwrap();
8567                 let mut w = test_utils::TestVecWriter(Vec::new());
8568                 monitor.write(&mut w).unwrap();
8569                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8570                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8571                 assert!(new_monitor == *monitor);
8572                 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);
8573                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8574                 watchtower
8575         };
8576         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8577         watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8578
8579         // Try to update ChannelMonitor
8580         assert!(nodes[1].node.claim_funds(preimage));
8581         check_added_monitors!(nodes[1], 1);
8582         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8583         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8584         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8585         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8586                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8587                         if let Err(_) =  watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8588                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8589                 } else { assert!(false); }
8590         } else { assert!(false); };
8591         // Our local monitor is in-sync and hasn't processed yet timeout
8592         check_added_monitors!(nodes[0], 1);
8593         let events = nodes[0].node.get_and_clear_pending_events();
8594         assert_eq!(events.len(), 1);
8595 }
8596
8597 #[test]
8598 fn test_concurrent_monitor_claim() {
8599         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8600         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8601         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8602         // state N+1 confirms. Alice claims output from state N+1.
8603
8604         let chanmon_cfgs = create_chanmon_cfgs(2);
8605         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8606         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8607         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8608
8609         // Create some initial channel
8610         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8611         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8612
8613         // Rebalance the network to generate htlc in the two directions
8614         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8615
8616         // Route a HTLC from node 0 to node 1 (but don't settle)
8617         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8618
8619         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8620         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8621         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8622         let persister = test_utils::TestPersister::new();
8623         let watchtower_alice = {
8624                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8625                 let monitor = monitors.get(&outpoint).unwrap();
8626                 let mut w = test_utils::TestVecWriter(Vec::new());
8627                 monitor.write(&mut w).unwrap();
8628                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8629                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8630                 assert!(new_monitor == *monitor);
8631                 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);
8632                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8633                 watchtower
8634         };
8635         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8636         watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8637
8638         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8639         {
8640                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8641                 assert_eq!(txn.len(), 2);
8642                 txn.clear();
8643         }
8644
8645         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8646         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8647         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8648         let persister = test_utils::TestPersister::new();
8649         let watchtower_bob = {
8650                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8651                 let monitor = monitors.get(&outpoint).unwrap();
8652                 let mut w = test_utils::TestVecWriter(Vec::new());
8653                 monitor.write(&mut w).unwrap();
8654                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8655                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8656                 assert!(new_monitor == *monitor);
8657                 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);
8658                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8659                 watchtower
8660         };
8661         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8662         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8663
8664         // Route another payment to generate another update with still previous HTLC pending
8665         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8666         {
8667                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8668                 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();
8669                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8670         }
8671         check_added_monitors!(nodes[1], 1);
8672
8673         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8674         assert_eq!(updates.update_add_htlcs.len(), 1);
8675         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8676         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8677                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8678                         // Watchtower Alice should already have seen the block and reject the update
8679                         if let Err(_) =  watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8680                         if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8681                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8682                 } else { assert!(false); }
8683         } else { assert!(false); };
8684         // Our local monitor is in-sync and hasn't processed yet timeout
8685         check_added_monitors!(nodes[0], 1);
8686
8687         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8688         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8689         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8690
8691         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8692         let bob_state_y;
8693         {
8694                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8695                 assert_eq!(txn.len(), 2);
8696                 bob_state_y = txn[0].clone();
8697                 txn.clear();
8698         };
8699
8700         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8701         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8702         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);
8703         {
8704                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8705                 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8706                 // the onchain detection of the HTLC output
8707                 assert_eq!(htlc_txn.len(), 2);
8708                 check_spends!(htlc_txn[0], bob_state_y);
8709                 check_spends!(htlc_txn[1], bob_state_y);
8710         }
8711 }
8712
8713 #[test]
8714 fn test_pre_lockin_no_chan_closed_update() {
8715         // Test that if a peer closes a channel in response to a funding_created message we don't
8716         // generate a channel update (as the channel cannot appear on chain without a funding_signed
8717         // message).
8718         //
8719         // Doing so would imply a channel monitor update before the initial channel monitor
8720         // registration, violating our API guarantees.
8721         //
8722         // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8723         // then opening a second channel with the same funding output as the first (which is not
8724         // rejected because the first channel does not exist in the ChannelManager) and closing it
8725         // before receiving funding_signed.
8726         let chanmon_cfgs = create_chanmon_cfgs(2);
8727         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8728         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8729         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8730
8731         // Create an initial channel
8732         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8733         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8734         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8735         let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8736         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8737
8738         // Move the first channel through the funding flow...
8739         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8740
8741         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8742         check_added_monitors!(nodes[0], 0);
8743
8744         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8745         let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8746         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8747         assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8748 }
8749
8750 #[test]
8751 fn test_htlc_no_detection() {
8752         // This test is a mutation to underscore the detection logic bug we had
8753         // before #653. HTLC value routed is above the remaining balance, thus
8754         // inverting HTLC and `to_remote` output. HTLC will come second and
8755         // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8756         // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8757         // outputs order detection for correct spending children filtring.
8758
8759         let chanmon_cfgs = create_chanmon_cfgs(2);
8760         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8761         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8762         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8763
8764         // Create some initial channels
8765         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8766
8767         send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8768         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8769         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8770         assert_eq!(local_txn[0].input.len(), 1);
8771         assert_eq!(local_txn[0].output.len(), 3);
8772         check_spends!(local_txn[0], chan_1.3);
8773
8774         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8775         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8776         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8777         // We deliberately connect the local tx twice as this should provoke a failure calling
8778         // this test before #653 fix.
8779         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);
8780         check_closed_broadcast!(nodes[0], true);
8781         check_added_monitors!(nodes[0], 1);
8782
8783         let htlc_timeout = {
8784                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8785                 assert_eq!(node_txn[0].input.len(), 1);
8786                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8787                 check_spends!(node_txn[0], local_txn[0]);
8788                 node_txn[0].clone()
8789         };
8790
8791         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8792         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8793         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8794         expect_payment_failed!(nodes[0], our_payment_hash, true);
8795 }
8796
8797 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8798         // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8799         // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8800         // Carol, Alice would be the upstream node, and Carol the downstream.)
8801         //
8802         // Steps of the test:
8803         // 1) Alice sends a HTLC to Carol through Bob.
8804         // 2) Carol doesn't settle the HTLC.
8805         // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8806         // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8807         // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8808         //    but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8809         // 5) Carol release the preimage to Bob off-chain.
8810         // 6) Bob claims the offered output on the broadcasted commitment.
8811         let chanmon_cfgs = create_chanmon_cfgs(3);
8812         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8813         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8814         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8815
8816         // Create some initial channels
8817         let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8818         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8819
8820         // Steps (1) and (2):
8821         // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8822         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8823
8824         // Check that Alice's commitment transaction now contains an output for this HTLC.
8825         let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8826         check_spends!(alice_txn[0], chan_ab.3);
8827         assert_eq!(alice_txn[0].output.len(), 2);
8828         check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8829         assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8830         assert_eq!(alice_txn.len(), 2);
8831
8832         // Steps (3) and (4):
8833         // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8834         // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8835         let mut force_closing_node = 0; // Alice force-closes
8836         if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8837         nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8838         check_closed_broadcast!(nodes[force_closing_node], true);
8839         check_added_monitors!(nodes[force_closing_node], 1);
8840         if go_onchain_before_fulfill {
8841                 let txn_to_broadcast = match broadcast_alice {
8842                         true => alice_txn.clone(),
8843                         false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8844                 };
8845                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8846                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8847                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8848                 if broadcast_alice {
8849                         check_closed_broadcast!(nodes[1], true);
8850                         check_added_monitors!(nodes[1], 1);
8851                 }
8852                 assert_eq!(bob_txn.len(), 1);
8853                 check_spends!(bob_txn[0], chan_ab.3);
8854         }
8855
8856         // Step (5):
8857         // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8858         // process of removing the HTLC from their commitment transactions.
8859         assert!(nodes[2].node.claim_funds(payment_preimage));
8860         check_added_monitors!(nodes[2], 1);
8861         let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8862         assert!(carol_updates.update_add_htlcs.is_empty());
8863         assert!(carol_updates.update_fail_htlcs.is_empty());
8864         assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8865         assert!(carol_updates.update_fee.is_none());
8866         assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8867
8868         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8869         // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8870         if !go_onchain_before_fulfill && broadcast_alice {
8871                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8872                 assert_eq!(events.len(), 1);
8873                 match events[0] {
8874                         MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8875                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8876                         },
8877                         _ => panic!("Unexpected event"),
8878                 };
8879         }
8880         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8881         // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8882         // Carol<->Bob's updated commitment transaction info.
8883         check_added_monitors!(nodes[1], 2);
8884
8885         let events = nodes[1].node.get_and_clear_pending_msg_events();
8886         assert_eq!(events.len(), 2);
8887         let bob_revocation = match events[0] {
8888                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8889                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8890                         (*msg).clone()
8891                 },
8892                 _ => panic!("Unexpected event"),
8893         };
8894         let bob_updates = match events[1] {
8895                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8896                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8897                         (*updates).clone()
8898                 },
8899                 _ => panic!("Unexpected event"),
8900         };
8901
8902         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8903         check_added_monitors!(nodes[2], 1);
8904         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8905         check_added_monitors!(nodes[2], 1);
8906
8907         let events = nodes[2].node.get_and_clear_pending_msg_events();
8908         assert_eq!(events.len(), 1);
8909         let carol_revocation = match events[0] {
8910                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8911                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8912                         (*msg).clone()
8913                 },
8914                 _ => panic!("Unexpected event"),
8915         };
8916         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8917         check_added_monitors!(nodes[1], 1);
8918
8919         // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8920         // here's where we put said channel's commitment tx on-chain.
8921         let mut txn_to_broadcast = alice_txn.clone();
8922         if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8923         if !go_onchain_before_fulfill {
8924                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8925                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8926                 // If Bob was the one to force-close, he will have already passed these checks earlier.
8927                 if broadcast_alice {
8928                         check_closed_broadcast!(nodes[1], true);
8929                         check_added_monitors!(nodes[1], 1);
8930                 }
8931                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8932                 if broadcast_alice {
8933                         // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8934                         // new block being connected. The ChannelManager being notified triggers a monitor update,
8935                         // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8936                         // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8937                         // broadcasted.
8938                         assert_eq!(bob_txn.len(), 3);
8939                         check_spends!(bob_txn[1], chan_ab.3);
8940                 } else {
8941                         assert_eq!(bob_txn.len(), 2);
8942                         check_spends!(bob_txn[0], chan_ab.3);
8943                 }
8944         }
8945
8946         // Step (6):
8947         // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8948         // broadcasted commitment transaction.
8949         {
8950                 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8951                 if go_onchain_before_fulfill {
8952                         // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
8953                         assert_eq!(bob_txn.len(), 2);
8954                 }
8955                 let script_weight = match broadcast_alice {
8956                         true => OFFERED_HTLC_SCRIPT_WEIGHT,
8957                         false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8958                 };
8959                 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
8960                 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
8961                 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
8962                 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
8963                 if broadcast_alice && !go_onchain_before_fulfill {
8964                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
8965                         assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
8966                 } else {
8967                         check_spends!(bob_txn[1], txn_to_broadcast[0]);
8968                         assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
8969                 }
8970         }
8971 }
8972
8973 #[test]
8974 fn test_onchain_htlc_settlement_after_close() {
8975         do_test_onchain_htlc_settlement_after_close(true, true);
8976         do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
8977         do_test_onchain_htlc_settlement_after_close(true, false);
8978         do_test_onchain_htlc_settlement_after_close(false, false);
8979 }
8980
8981 #[test]
8982 fn test_duplicate_chan_id() {
8983         // Test that if a given peer tries to open a channel with the same channel_id as one that is
8984         // already open we reject it and keep the old channel.
8985         //
8986         // Previously, full_stack_target managed to figure out that if you tried to open two channels
8987         // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
8988         // the existing channel when we detect the duplicate new channel, screwing up our monitor
8989         // updating logic for the existing channel.
8990         let chanmon_cfgs = create_chanmon_cfgs(2);
8991         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8992         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8993         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8994
8995         // Create an initial channel
8996         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8997         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8998         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8999         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()));
9000
9001         // Try to create a second channel with the same temporary_channel_id as the first and check
9002         // that it is rejected.
9003         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9004         {
9005                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9006                 assert_eq!(events.len(), 1);
9007                 match events[0] {
9008                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9009                                 // Technically, at this point, nodes[1] would be justified in thinking both the
9010                                 // first (valid) and second (invalid) channels are closed, given they both have
9011                                 // the same non-temporary channel_id. However, currently we do not, so we just
9012                                 // move forward with it.
9013                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9014                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9015                         },
9016                         _ => panic!("Unexpected event"),
9017                 }
9018         }
9019
9020         // Move the first channel through the funding flow...
9021         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
9022
9023         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9024         check_added_monitors!(nodes[0], 0);
9025
9026         let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9027         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9028         {
9029                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9030                 assert_eq!(added_monitors.len(), 1);
9031                 assert_eq!(added_monitors[0].0, funding_output);
9032                 added_monitors.clear();
9033         }
9034         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9035
9036         let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
9037         let channel_id = funding_outpoint.to_channel_id();
9038
9039         // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
9040         // temporary one).
9041
9042         // First try to open a second channel with a temporary channel id equal to the txid-based one.
9043         // Technically this is allowed by the spec, but we don't support it and there's little reason
9044         // to. Still, it shouldn't cause any other issues.
9045         open_chan_msg.temporary_channel_id = channel_id;
9046         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9047         {
9048                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9049                 assert_eq!(events.len(), 1);
9050                 match events[0] {
9051                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9052                                 // Technically, at this point, nodes[1] would be justified in thinking both
9053                                 // channels are closed, but currently we do not, so we just move forward with it.
9054                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9055                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9056                         },
9057                         _ => panic!("Unexpected event"),
9058                 }
9059         }
9060
9061         // Now try to create a second channel which has a duplicate funding output.
9062         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9063         let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9064         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
9065         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()));
9066         create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
9067
9068         let funding_created = {
9069                 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
9070                 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
9071                 let logger = test_utils::TestLogger::new();
9072                 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
9073         };
9074         check_added_monitors!(nodes[0], 0);
9075         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
9076         // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
9077         // still needs to be cleared here.
9078         check_added_monitors!(nodes[1], 1);
9079
9080         // ...still, nodes[1] will reject the duplicate channel.
9081         {
9082                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9083                 assert_eq!(events.len(), 1);
9084                 match events[0] {
9085                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9086                                 // Technically, at this point, nodes[1] would be justified in thinking both
9087                                 // channels are closed, but currently we do not, so we just move forward with it.
9088                                 assert_eq!(msg.channel_id, channel_id);
9089                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9090                         },
9091                         _ => panic!("Unexpected event"),
9092                 }
9093         }
9094
9095         // finally, finish creating the original channel and send a payment over it to make sure
9096         // everything is functional.
9097         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9098         {
9099                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9100                 assert_eq!(added_monitors.len(), 1);
9101                 assert_eq!(added_monitors[0].0, funding_output);
9102                 added_monitors.clear();
9103         }
9104
9105         let events_4 = nodes[0].node.get_and_clear_pending_events();
9106         assert_eq!(events_4.len(), 0);
9107         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9108         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
9109
9110         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9111         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9112         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9113         send_payment(&nodes[0], &[&nodes[1]], 8000000);
9114 }
9115
9116 #[test]
9117 fn test_error_chans_closed() {
9118         // Test that we properly handle error messages, closing appropriate channels.
9119         //
9120         // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9121         // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9122         // we can test various edge cases around it to ensure we don't regress.
9123         let chanmon_cfgs = create_chanmon_cfgs(3);
9124         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9125         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9126         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9127
9128         // Create some initial channels
9129         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9130         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9131         let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9132
9133         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9134         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9135         assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9136
9137         // Closing a channel from a different peer has no effect
9138         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9139         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9140
9141         // Closing one channel doesn't impact others
9142         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9143         check_added_monitors!(nodes[0], 1);
9144         check_closed_broadcast!(nodes[0], false);
9145         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9146         assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9147         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);
9148         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);
9149
9150         // A null channel ID should close all channels
9151         let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9152         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9153         check_added_monitors!(nodes[0], 2);
9154         let events = nodes[0].node.get_and_clear_pending_msg_events();
9155         assert_eq!(events.len(), 2);
9156         match events[0] {
9157                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9158                         assert_eq!(msg.contents.flags & 2, 2);
9159                 },
9160                 _ => panic!("Unexpected event"),
9161         }
9162         match events[1] {
9163                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9164                         assert_eq!(msg.contents.flags & 2, 2);
9165                 },
9166                 _ => panic!("Unexpected event"),
9167         }
9168         // Note that at this point users of a standard PeerHandler will end up calling
9169         // peer_disconnected with no_connection_possible set to false, duplicating the
9170         // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9171         // users with their own peer handling logic. We duplicate the call here, however.
9172         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9173         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9174
9175         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9176         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9177         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9178 }
9179
9180 #[test]
9181 fn test_invalid_funding_tx() {
9182         // Test that we properly handle invalid funding transactions sent to us from a peer.
9183         //
9184         // Previously, all other major lightning implementations had failed to properly sanitize
9185         // funding transactions from their counterparties, leading to a multi-implementation critical
9186         // security vulnerability (though we always sanitized properly, we've previously had
9187         // un-released crashes in the sanitization process).
9188         let chanmon_cfgs = create_chanmon_cfgs(2);
9189         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9190         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9191         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9192
9193         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9194         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()));
9195         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()));
9196
9197         let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9198         for output in tx.output.iter_mut() {
9199                 // Make the confirmed funding transaction have a bogus script_pubkey
9200                 output.script_pubkey = bitcoin::Script::new();
9201         }
9202
9203         nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9204         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()));
9205         check_added_monitors!(nodes[1], 1);
9206
9207         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()));
9208         check_added_monitors!(nodes[0], 1);
9209
9210         let events_1 = nodes[0].node.get_and_clear_pending_events();
9211         assert_eq!(events_1.len(), 0);
9212
9213         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9214         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9215         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9216
9217         confirm_transaction_at(&nodes[1], &tx, 1);
9218         check_added_monitors!(nodes[1], 1);
9219         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9220         assert_eq!(events_2.len(), 1);
9221         if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9222                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9223                 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9224                         assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9225                 } else { panic!(); }
9226         } else { panic!(); }
9227         assert_eq!(nodes[1].node.list_channels().len(), 0);
9228 }