_ 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 prelude::*;
  54 use alloc::collections::BTreeSet;
  55 use std::collections::{HashMap, HashSet};
  56 use core::default::Default;
  57 use std::sync::Mutex;
  58
  59 use ln::functional_test_utils::*;
  60 use ln::chan_utils::CommitmentTransaction;
  61 use ln::msgs::OptionalField::Present;
  62
  63 #[test]
  64 fn test_insane_channel_opens() {
  65         // Stand up a network of 2 nodes
  66         let chanmon_cfgs = create_chanmon_cfgs(2);
  67         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  68         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  69         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  70
  71         // Instantiate channel parameters where we push the maximum msats given our
  72         // funding satoshis
  73         let channel_value_sat = 31337; // same as funding satoshis
  74         let channel_reserve_satoshis = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value_sat);
  75         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  76
  77         // Have node0 initiate a channel to node1 with aforementioned parameters
  78         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
  79
  80         // Extract the channel open message from node0 to node1
  81         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  82
  83         // Test helper that asserts we get the correct error string given a mutator
  84         // that supposedly makes the channel open message insane
  85         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  86                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
  87                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  88                 assert_eq!(msg_events.len(), 1);
  89                 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
  90                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  91                         match action {
  92                                 &ErrorAction::SendErrorMessage { .. } => {
  93                                         nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
  94                                 },
  95                                 _ => panic!("unexpected event!"),
  96                         }
  97                 } else { assert!(false); }
  98         };
  99
 100         use ln::channel::MAX_FUNDING_SATOSHIS;
 101         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
 102
 103         // Test all mutations that would make the channel open message insane
 104         insane_open_helper(format!("Funding must be smaller than {}. It was {}", MAX_FUNDING_SATOSHIS, MAX_FUNDING_SATOSHIS).as_str(), |mut msg| { msg.funding_satoshis = MAX_FUNDING_SATOSHIS; msg });
 105
 106         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
 107
 108         insane_open_helper(r"push_msat \d+ was larger than funding value \d+", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
 109
 110         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
 111
 112         insane_open_helper(r"Bogus; channel reserve \(\d+\) is less than dust limit \(\d+\)", |mut msg| { msg.dust_limit_satoshis = msg.channel_reserve_satoshis + 1; msg });
 113
 114         insane_open_helper(r"Minimum htlc value \(\d+\) was larger than full channel value \(\d+\)", |mut msg| { msg.htlc_minimum_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000; msg });
 115
 116         insane_open_helper("They wanted our payments to be delayed by a needlessly long period", |mut msg| { msg.to_self_delay = MAX_LOCAL_BREAKDOWN_TIMEOUT + 1; msg });
 117
 118         insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 119
 120         insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 121 }
 122
 123 #[test]
 124 fn test_async_inbound_update_fee() {
 125         let chanmon_cfgs = create_chanmon_cfgs(2);
 126         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 127         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 128         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 129         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 130         let logger = test_utils::TestLogger::new();
 131         let channel_id = chan.2;
 132
 133         // balancing
 134         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 135
 136         // A                                        B
 137         // update_fee                            ->
 138         // send (1) commitment_signed            -.
 139         //                                       <- update_add_htlc/commitment_signed
 140         // send (2) RAA (awaiting remote revoke) -.
 141         // (1) commitment_signed is delivered    ->
 142         //                                       .- send (3) RAA (awaiting remote revoke)
 143         // (2) RAA is delivered                  ->
 144         //                                       .- send (4) commitment_signed
 145         //                                       <- (3) RAA is delivered
 146         // send (5) commitment_signed            -.
 147         //                                       <- (4) commitment_signed is delivered
 148         // send (6) RAA                          -.
 149         // (5) commitment_signed is delivered    ->
 150         //                                       <- RAA
 151         // (6) RAA is delivered                  ->
 152
 153         // First nodes[0] generates an update_fee
 154         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 155         check_added_monitors!(nodes[0], 1);
 156
 157         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 158         assert_eq!(events_0.len(), 1);
 159         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 160                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 161                         (update_fee.as_ref(), commitment_signed)
 162                 },
 163                 _ => panic!("Unexpected event"),
 164         };
 165
 166         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 167
 168         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 169         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 170         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 171         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();
 172         check_added_monitors!(nodes[1], 1);
 173
 174         let payment_event = {
 175                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 176                 assert_eq!(events_1.len(), 1);
 177                 SendEvent::from_event(events_1.remove(0))
 178         };
 179         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 180         assert_eq!(payment_event.msgs.len(), 1);
 181
 182         // ...now when the messages get delivered everyone should be happy
 183         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 184         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 185         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 186         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 187         check_added_monitors!(nodes[0], 1);
 188
 189         // deliver(1), generate (3):
 190         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 191         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 192         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 193         check_added_monitors!(nodes[1], 1);
 194
 195         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 196         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 197         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 198         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 199         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 200         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 201         assert!(bs_update.update_fee.is_none()); // (4)
 202         check_added_monitors!(nodes[1], 1);
 203
 204         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 205         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 206         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 207         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 208         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 209         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 210         assert!(as_update.update_fee.is_none()); // (5)
 211         check_added_monitors!(nodes[0], 1);
 212
 213         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 214         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 215         // only (6) so get_event_msg's assert(len == 1) passes
 216         check_added_monitors!(nodes[0], 1);
 217
 218         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 219         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 220         check_added_monitors!(nodes[1], 1);
 221
 222         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 223         check_added_monitors!(nodes[0], 1);
 224
 225         let events_2 = nodes[0].node.get_and_clear_pending_events();
 226         assert_eq!(events_2.len(), 1);
 227         match events_2[0] {
 228                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 229                 _ => panic!("Unexpected event"),
 230         }
 231
 232         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 233         check_added_monitors!(nodes[1], 1);
 234 }
 235
 236 #[test]
 237 fn test_update_fee_unordered_raa() {
 238         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 239         // crash in an earlier version of the update_fee patch)
 240         let chanmon_cfgs = create_chanmon_cfgs(2);
 241         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 242         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 243         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 244         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 245         let channel_id = chan.2;
 246         let logger = test_utils::TestLogger::new();
 247
 248         // balancing
 249         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 250
 251         // First nodes[0] generates an update_fee
 252         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 253         check_added_monitors!(nodes[0], 1);
 254
 255         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 256         assert_eq!(events_0.len(), 1);
 257         let update_msg = match events_0[0] { // (1)
 258                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 259                         update_fee.as_ref()
 260                 },
 261                 _ => panic!("Unexpected event"),
 262         };
 263
 264         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 265
 266         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 267         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 268         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 269         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();
 270         check_added_monitors!(nodes[1], 1);
 271
 272         let payment_event = {
 273                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 274                 assert_eq!(events_1.len(), 1);
 275                 SendEvent::from_event(events_1.remove(0))
 276         };
 277         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 278         assert_eq!(payment_event.msgs.len(), 1);
 279
 280         // ...now when the messages get delivered everyone should be happy
 281         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 282         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 283         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 284         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 285         check_added_monitors!(nodes[0], 1);
 286
 287         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 288         check_added_monitors!(nodes[1], 1);
 289
 290         // We can't continue, sadly, because our (1) now has a bogus signature
 291 }
 292
 293 #[test]
 294 fn test_multi_flight_update_fee() {
 295         let chanmon_cfgs = create_chanmon_cfgs(2);
 296         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 297         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 298         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 299         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 300         let channel_id = chan.2;
 301
 302         // A                                        B
 303         // update_fee/commitment_signed          ->
 304         //                                       .- send (1) RAA and (2) commitment_signed
 305         // update_fee (never committed)          ->
 306         // (3) update_fee                        ->
 307         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 308         // don't track which updates correspond to which revoke_and_ack responses so we're in
 309         // AwaitingRAA mode and will not generate the update_fee yet.
 310         //                                       <- (1) RAA delivered
 311         // (3) is generated and send (4) CS      -.
 312         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 313         // know the per_commitment_point to use for it.
 314         //                                       <- (2) commitment_signed delivered
 315         // revoke_and_ack                        ->
 316         //                                          B should send no response here
 317         // (4) commitment_signed delivered       ->
 318         //                                       <- RAA/commitment_signed delivered
 319         // revoke_and_ack                        ->
 320
 321         // First nodes[0] generates an update_fee
 322         let initial_feerate = get_feerate!(nodes[0], channel_id);
 323         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
 324         check_added_monitors!(nodes[0], 1);
 325
 326         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 327         assert_eq!(events_0.len(), 1);
 328         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 329                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 330                         (update_fee.as_ref().unwrap(), commitment_signed)
 331                 },
 332                 _ => panic!("Unexpected event"),
 333         };
 334
 335         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 336         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 337         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 338         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 339         check_added_monitors!(nodes[1], 1);
 340
 341         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 342         // transaction:
 343         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
 344         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 345         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 346
 347         // Create the (3) update_fee message that nodes[0] will generate before it does...
 348         let mut update_msg_2 = msgs::UpdateFee {
 349                 channel_id: update_msg_1.channel_id.clone(),
 350                 feerate_per_kw: (initial_feerate + 30) as u32,
 351         };
 352
 353         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 354
 355         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 356         // Deliver (3)
 357         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 358
 359         // Deliver (1), generating (3) and (4)
 360         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 361         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 362         check_added_monitors!(nodes[0], 1);
 363         assert!(as_second_update.update_add_htlcs.is_empty());
 364         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 365         assert!(as_second_update.update_fail_htlcs.is_empty());
 366         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 367         // Check that the update_fee newly generated matches what we delivered:
 368         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 369         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 370
 371         // Deliver (2) commitment_signed
 372         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 373         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 374         check_added_monitors!(nodes[0], 1);
 375         // No commitment_signed so get_event_msg's assert(len == 1) passes
 376
 377         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 378         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 379         check_added_monitors!(nodes[1], 1);
 380
 381         // Delever (4)
 382         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 383         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 384         check_added_monitors!(nodes[1], 1);
 385
 386         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 387         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 388         check_added_monitors!(nodes[0], 1);
 389
 390         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 391         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 392         // No commitment_signed so get_event_msg's assert(len == 1) passes
 393         check_added_monitors!(nodes[0], 1);
 394
 395         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 396         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 397         check_added_monitors!(nodes[1], 1);
 398 }
 399
 400 fn do_test_1_conf_open(connect_style: ConnectStyle) {
 401         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 402         // tests that we properly send one in that case.
 403         let mut alice_config = UserConfig::default();
 404         alice_config.own_channel_config.minimum_depth = 1;
 405         alice_config.channel_options.announced_channel = true;
 406         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 407         let mut bob_config = UserConfig::default();
 408         bob_config.own_channel_config.minimum_depth = 1;
 409         bob_config.channel_options.announced_channel = true;
 410         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 411         let chanmon_cfgs = create_chanmon_cfgs(2);
 412         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 413         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 414         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 415         *nodes[0].connect_style.borrow_mut() = connect_style;
 416
 417         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
 418         mine_transaction(&nodes[1], &tx);
 419         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()));
 420
 421         mine_transaction(&nodes[0], &tx);
 422         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 423         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 424
 425         for node in nodes {
 426                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
 427                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
 428                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
 429         }
 430 }
 431 #[test]
 432 fn test_1_conf_open() {
 433         do_test_1_conf_open(ConnectStyle::BestBlockFirst);
 434         do_test_1_conf_open(ConnectStyle::TransactionsFirst);
 435         do_test_1_conf_open(ConnectStyle::FullBlockViaListen);
 436 }
 437
 438 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 439         // Previously, we had issues deserializing channels when we hadn't connected the first block
 440         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 441         // serialization round-trips and simply do steps towards opening a channel and then drop the
 442         // Node objects.
 443
 444         let chanmon_cfgs = create_chanmon_cfgs(2);
 445         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 446         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 447         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 448
 449         if steps & 0b1000_0000 != 0{
 450                 let block = Block {
 451                         header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 452                         txdata: vec![],
 453                 };
 454                 connect_block(&nodes[0], &block);
 455                 connect_block(&nodes[1], &block);
 456         }
 457
 458         if steps & 0x0f == 0 { return; }
 459         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 460         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 461
 462         if steps & 0x0f == 1 { return; }
 463         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
 464         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 465
 466         if steps & 0x0f == 2 { return; }
 467         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
 468
 469         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 470
 471         if steps & 0x0f == 3 { return; }
 472         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
 473         check_added_monitors!(nodes[0], 0);
 474         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 475
 476         if steps & 0x0f == 4 { return; }
 477         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 478         {
 479                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 480                 assert_eq!(added_monitors.len(), 1);
 481                 assert_eq!(added_monitors[0].0, funding_output);
 482                 added_monitors.clear();
 483         }
 484         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 485
 486         if steps & 0x0f == 5 { return; }
 487         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 488         {
 489                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 490                 assert_eq!(added_monitors.len(), 1);
 491                 assert_eq!(added_monitors[0].0, funding_output);
 492                 added_monitors.clear();
 493         }
 494
 495         let events_4 = nodes[0].node.get_and_clear_pending_events();
 496         assert_eq!(events_4.len(), 0);
 497
 498         if steps & 0x0f == 6 { return; }
 499         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
 500
 501         if steps & 0x0f == 7 { return; }
 502         confirm_transaction_at(&nodes[0], &tx, 2);
 503         connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
 504         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 505 }
 506
 507 #[test]
 508 fn test_sanity_on_in_flight_opens() {
 509         do_test_sanity_on_in_flight_opens(0);
 510         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 511         do_test_sanity_on_in_flight_opens(1);
 512         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 513         do_test_sanity_on_in_flight_opens(2);
 514         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 515         do_test_sanity_on_in_flight_opens(3);
 516         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 517         do_test_sanity_on_in_flight_opens(4);
 518         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 519         do_test_sanity_on_in_flight_opens(5);
 520         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 521         do_test_sanity_on_in_flight_opens(6);
 522         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 523         do_test_sanity_on_in_flight_opens(7);
 524         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 525         do_test_sanity_on_in_flight_opens(8);
 526         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 527 }
 528
 529 #[test]
 530 fn test_update_fee_vanilla() {
 531         let chanmon_cfgs = create_chanmon_cfgs(2);
 532         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 533         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 534         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 535         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 536         let channel_id = chan.2;
 537
 538         let feerate = get_feerate!(nodes[0], channel_id);
 539         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 540         check_added_monitors!(nodes[0], 1);
 541
 542         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 543         assert_eq!(events_0.len(), 1);
 544         let (update_msg, commitment_signed) = match events_0[0] {
 545                         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 } } => {
 546                         (update_fee.as_ref(), commitment_signed)
 547                 },
 548                 _ => panic!("Unexpected event"),
 549         };
 550         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 551
 552         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 553         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 554         check_added_monitors!(nodes[1], 1);
 555
 556         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 557         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 558         check_added_monitors!(nodes[0], 1);
 559
 560         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 561         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 562         // No commitment_signed so get_event_msg's assert(len == 1) passes
 563         check_added_monitors!(nodes[0], 1);
 564
 565         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 566         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 567         check_added_monitors!(nodes[1], 1);
 568 }
 569
 570 #[test]
 571 fn test_update_fee_that_funder_cannot_afford() {
 572         let chanmon_cfgs = create_chanmon_cfgs(2);
 573         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 574         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 575         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 576         let channel_value = 1888;
 577         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
 578         let channel_id = chan.2;
 579
 580         let feerate = 260;
 581         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 582         check_added_monitors!(nodes[0], 1);
 583         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 584
 585         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 586
 587         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 588
 589         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 590         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 591         {
 592                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 593
 594                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 595                 let num_htlcs = commitment_tx.output.len() - 2;
 596                 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 597                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 598                 actual_fee = channel_value - actual_fee;
 599                 assert_eq!(total_fee, actual_fee);
 600         }
 601
 602         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 603         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 604         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 605         check_added_monitors!(nodes[0], 1);
 606
 607         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 608
 609         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 610
 611         //While producing the commitment_signed response after handling a received update_fee request the
 612         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 613         //Should produce and error.
 614         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 615         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 616         check_added_monitors!(nodes[1], 1);
 617         check_closed_broadcast!(nodes[1], true);
 618 }
 619
 620 #[test]
 621 fn test_update_fee_with_fundee_update_add_htlc() {
 622         let chanmon_cfgs = create_chanmon_cfgs(2);
 623         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 624         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 625         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 626         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 627         let channel_id = chan.2;
 628         let logger = test_utils::TestLogger::new();
 629
 630         // balancing
 631         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 632
 633         let feerate = get_feerate!(nodes[0], channel_id);
 634         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 635         check_added_monitors!(nodes[0], 1);
 636
 637         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 638         assert_eq!(events_0.len(), 1);
 639         let (update_msg, commitment_signed) = match events_0[0] {
 640                         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 } } => {
 641                         (update_fee.as_ref(), commitment_signed)
 642                 },
 643                 _ => panic!("Unexpected event"),
 644         };
 645         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 646         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 647         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 648         check_added_monitors!(nodes[1], 1);
 649
 650         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 651         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 652         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();
 653
 654         // nothing happens since node[1] is in AwaitingRemoteRevoke
 655         nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
 656         {
 657                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 658                 assert_eq!(added_monitors.len(), 0);
 659                 added_monitors.clear();
 660         }
 661         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 662         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 663         // node[1] has nothing to do
 664
 665         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 666         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 667         check_added_monitors!(nodes[0], 1);
 668
 669         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 670         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 671         // No commitment_signed so get_event_msg's assert(len == 1) passes
 672         check_added_monitors!(nodes[0], 1);
 673         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 674         check_added_monitors!(nodes[1], 1);
 675         // AwaitingRemoteRevoke ends here
 676
 677         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 678         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 679         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 680         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 681         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 682         assert_eq!(commitment_update.update_fee.is_none(), true);
 683
 684         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 685         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 686         check_added_monitors!(nodes[0], 1);
 687         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 688
 689         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 690         check_added_monitors!(nodes[1], 1);
 691         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 692
 693         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 694         check_added_monitors!(nodes[1], 1);
 695         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 696         // No commitment_signed so get_event_msg's assert(len == 1) passes
 697
 698         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 699         check_added_monitors!(nodes[0], 1);
 700         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 701
 702         expect_pending_htlcs_forwardable!(nodes[0]);
 703
 704         let events = nodes[0].node.get_and_clear_pending_events();
 705         assert_eq!(events.len(), 1);
 706         match events[0] {
 707                 Event::PaymentReceived { .. } => { },
 708                 _ => panic!("Unexpected event"),
 709         };
 710
 711         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
 712
 713         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
 714         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
 715         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 716 }
 717
 718 #[test]
 719 fn test_update_fee() {
 720         let chanmon_cfgs = create_chanmon_cfgs(2);
 721         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 722         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 723         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 724         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 725         let channel_id = chan.2;
 726
 727         // A                                        B
 728         // (1) update_fee/commitment_signed      ->
 729         //                                       <- (2) revoke_and_ack
 730         //                                       .- send (3) commitment_signed
 731         // (4) update_fee/commitment_signed      ->
 732         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 733         //                                       <- (3) commitment_signed delivered
 734         // send (6) revoke_and_ack               -.
 735         //                                       <- (5) deliver revoke_and_ack
 736         // (6) deliver revoke_and_ack            ->
 737         //                                       .- send (7) commitment_signed in response to (4)
 738         //                                       <- (7) deliver commitment_signed
 739         // revoke_and_ack                        ->
 740
 741         // Create and deliver (1)...
 742         let feerate = get_feerate!(nodes[0], channel_id);
 743         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 744         check_added_monitors!(nodes[0], 1);
 745
 746         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 747         assert_eq!(events_0.len(), 1);
 748         let (update_msg, commitment_signed) = match events_0[0] {
 749                         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 } } => {
 750                         (update_fee.as_ref(), commitment_signed)
 751                 },
 752                 _ => panic!("Unexpected event"),
 753         };
 754         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 755
 756         // Generate (2) and (3):
 757         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 758         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 759         check_added_monitors!(nodes[1], 1);
 760
 761         // Deliver (2):
 762         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 763         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 764         check_added_monitors!(nodes[0], 1);
 765
 766         // Create and deliver (4)...
 767         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 768         check_added_monitors!(nodes[0], 1);
 769         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 770         assert_eq!(events_0.len(), 1);
 771         let (update_msg, commitment_signed) = match events_0[0] {
 772                         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 } } => {
 773                         (update_fee.as_ref(), commitment_signed)
 774                 },
 775                 _ => panic!("Unexpected event"),
 776         };
 777
 778         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 779         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 780         check_added_monitors!(nodes[1], 1);
 781         // ... creating (5)
 782         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 783         // No commitment_signed so get_event_msg's assert(len == 1) passes
 784
 785         // Handle (3), creating (6):
 786         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 787         check_added_monitors!(nodes[0], 1);
 788         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 789         // No commitment_signed so get_event_msg's assert(len == 1) passes
 790
 791         // Deliver (5):
 792         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 793         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 794         check_added_monitors!(nodes[0], 1);
 795
 796         // Deliver (6), creating (7):
 797         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 798         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 799         assert!(commitment_update.update_add_htlcs.is_empty());
 800         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 801         assert!(commitment_update.update_fail_htlcs.is_empty());
 802         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 803         assert!(commitment_update.update_fee.is_none());
 804         check_added_monitors!(nodes[1], 1);
 805
 806         // Deliver (7)
 807         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 808         check_added_monitors!(nodes[0], 1);
 809         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 810         // No commitment_signed so get_event_msg's assert(len == 1) passes
 811
 812         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 813         check_added_monitors!(nodes[1], 1);
 814         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 815
 816         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 817         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 818         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 819 }
 820
 821 #[test]
 822 fn pre_funding_lock_shutdown_test() {
 823         // Test sending a shutdown prior to funding_locked after funding generation
 824         let chanmon_cfgs = create_chanmon_cfgs(2);
 825         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 826         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 827         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 828         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
 829         mine_transaction(&nodes[0], &tx);
 830         mine_transaction(&nodes[1], &tx);
 831
 832         nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
 833         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 834         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 835         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 836         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 837
 838         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 839         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 840         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 841         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 842         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 843         assert!(node_0_none.is_none());
 844
 845         assert!(nodes[0].node.list_channels().is_empty());
 846         assert!(nodes[1].node.list_channels().is_empty());
 847 }
 848
 849 #[test]
 850 fn updates_shutdown_wait() {
 851         // Test sending a shutdown with outstanding updates pending
 852         let chanmon_cfgs = create_chanmon_cfgs(3);
 853         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 854         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 855         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 856         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 857         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 858         let logger = test_utils::TestLogger::new();
 859
 860         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 861
 862         nodes[0].node.close_channel(&chan_1.2).unwrap();
 863         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 864         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 865         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 866         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 867
 868         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 869         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 870
 871         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
 872
 873         let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
 874         let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
 875         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();
 876         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();
 877         unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
 878         unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
 879
 880         assert!(nodes[2].node.claim_funds(our_payment_preimage));
 881         check_added_monitors!(nodes[2], 1);
 882         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 883         assert!(updates.update_add_htlcs.is_empty());
 884         assert!(updates.update_fail_htlcs.is_empty());
 885         assert!(updates.update_fail_malformed_htlcs.is_empty());
 886         assert!(updates.update_fee.is_none());
 887         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 888         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 889         check_added_monitors!(nodes[1], 1);
 890         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 891         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 892
 893         assert!(updates_2.update_add_htlcs.is_empty());
 894         assert!(updates_2.update_fail_htlcs.is_empty());
 895         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 896         assert!(updates_2.update_fee.is_none());
 897         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 898         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 899         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 900
 901         let events = nodes[0].node.get_and_clear_pending_events();
 902         assert_eq!(events.len(), 1);
 903         match events[0] {
 904                 Event::PaymentSent { ref payment_preimage } => {
 905                         assert_eq!(our_payment_preimage, *payment_preimage);
 906                 },
 907                 _ => panic!("Unexpected event"),
 908         }
 909
 910         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 911         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 912         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 913         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 914         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 915         assert!(node_0_none.is_none());
 916
 917         assert!(nodes[0].node.list_channels().is_empty());
 918
 919         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 920         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 921         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 922         assert!(nodes[1].node.list_channels().is_empty());
 923         assert!(nodes[2].node.list_channels().is_empty());
 924 }
 925
 926 #[test]
 927 fn htlc_fail_async_shutdown() {
 928         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 929         let chanmon_cfgs = create_chanmon_cfgs(3);
 930         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 931         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 932         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 933         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 934         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 935         let logger = test_utils::TestLogger::new();
 936
 937         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
 938         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
 939         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();
 940         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
 941         check_added_monitors!(nodes[0], 1);
 942         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 943         assert_eq!(updates.update_add_htlcs.len(), 1);
 944         assert!(updates.update_fulfill_htlcs.is_empty());
 945         assert!(updates.update_fail_htlcs.is_empty());
 946         assert!(updates.update_fail_malformed_htlcs.is_empty());
 947         assert!(updates.update_fee.is_none());
 948
 949         nodes[1].node.close_channel(&chan_1.2).unwrap();
 950         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 951         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 952         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 953
 954         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 955         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 956         check_added_monitors!(nodes[1], 1);
 957         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 958         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 959
 960         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 961         assert!(updates_2.update_add_htlcs.is_empty());
 962         assert!(updates_2.update_fulfill_htlcs.is_empty());
 963         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 964         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 965         assert!(updates_2.update_fee.is_none());
 966
 967         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 968         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 969
 970         expect_payment_failed!(nodes[0], our_payment_hash, false);
 971
 972         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 973         assert_eq!(msg_events.len(), 2);
 974         let node_0_closing_signed = match msg_events[0] {
 975                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 976                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 977                         (*msg).clone()
 978                 },
 979                 _ => panic!("Unexpected event"),
 980         };
 981         match msg_events[1] {
 982                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 983                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 984                 },
 985                 _ => panic!("Unexpected event"),
 986         }
 987
 988         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 989         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 990         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 991         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 992         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 993         assert!(node_0_none.is_none());
 994
 995         assert!(nodes[0].node.list_channels().is_empty());
 996
 997         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 998         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 999         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1000         assert!(nodes[1].node.list_channels().is_empty());
1001         assert!(nodes[2].node.list_channels().is_empty());
1002 }
1003
1004 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1005         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1006         // messages delivered prior to disconnect
1007         let chanmon_cfgs = create_chanmon_cfgs(3);
1008         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1009         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1010         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1011         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1012         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1013
1014         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1015
1016         nodes[1].node.close_channel(&chan_1.2).unwrap();
1017         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1018         if recv_count > 0 {
1019                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
1020                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1021                 if recv_count > 1 {
1022                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
1023                 }
1024         }
1025
1026         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1027         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1028
1029         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1030         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1031         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1032         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1033
1034         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1035         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1036         assert!(node_1_shutdown == node_1_2nd_shutdown);
1037
1038         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1039         let node_0_2nd_shutdown = if recv_count > 0 {
1040                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1041                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1042                 node_0_2nd_shutdown
1043         } else {
1044                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1045                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1046                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1047         };
1048         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_2nd_shutdown);
1049
1050         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1051         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1052
1053         assert!(nodes[2].node.claim_funds(our_payment_preimage));
1054         check_added_monitors!(nodes[2], 1);
1055         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1056         assert!(updates.update_add_htlcs.is_empty());
1057         assert!(updates.update_fail_htlcs.is_empty());
1058         assert!(updates.update_fail_malformed_htlcs.is_empty());
1059         assert!(updates.update_fee.is_none());
1060         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1061         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1062         check_added_monitors!(nodes[1], 1);
1063         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1064         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1065
1066         assert!(updates_2.update_add_htlcs.is_empty());
1067         assert!(updates_2.update_fail_htlcs.is_empty());
1068         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1069         assert!(updates_2.update_fee.is_none());
1070         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1071         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1072         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1073
1074         let events = nodes[0].node.get_and_clear_pending_events();
1075         assert_eq!(events.len(), 1);
1076         match events[0] {
1077                 Event::PaymentSent { ref payment_preimage } => {
1078                         assert_eq!(our_payment_preimage, *payment_preimage);
1079                 },
1080                 _ => panic!("Unexpected event"),
1081         }
1082
1083         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1084         if recv_count > 0 {
1085                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1086                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1087                 assert!(node_1_closing_signed.is_some());
1088         }
1089
1090         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1091         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1092
1093         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1094         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1095         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1096         if recv_count == 0 {
1097                 // If all closing_signeds weren't delivered we can just resume where we left off...
1098                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1099
1100                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1101                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1102                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1103
1104                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1105                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1106                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1107
1108                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_3rd_shutdown);
1109                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1110
1111                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_3rd_shutdown);
1112                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1113                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1114
1115                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1116                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1117                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1118                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1119                 assert!(node_0_none.is_none());
1120         } else {
1121                 // If one node, however, received + responded with an identical closing_signed we end
1122                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1123                 // There isn't really anything better we can do simply, but in the future we might
1124                 // explore storing a set of recently-closed channels that got disconnected during
1125                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1126                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1127                 // transaction.
1128                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1129
1130                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1131                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1132                 assert_eq!(msg_events.len(), 1);
1133                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1134                         match action {
1135                                 &ErrorAction::SendErrorMessage { ref msg } => {
1136                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1137                                         assert_eq!(msg.channel_id, chan_1.2);
1138                                 },
1139                                 _ => panic!("Unexpected event!"),
1140                         }
1141                 } else { panic!("Needed SendErrorMessage close"); }
1142
1143                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1144                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1145                 // closing_signed so we do it ourselves
1146                 check_closed_broadcast!(nodes[0], false);
1147                 check_added_monitors!(nodes[0], 1);
1148         }
1149
1150         assert!(nodes[0].node.list_channels().is_empty());
1151
1152         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1153         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1154         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1155         assert!(nodes[1].node.list_channels().is_empty());
1156         assert!(nodes[2].node.list_channels().is_empty());
1157 }
1158
1159 #[test]
1160 fn test_shutdown_rebroadcast() {
1161         do_test_shutdown_rebroadcast(0);
1162         do_test_shutdown_rebroadcast(1);
1163         do_test_shutdown_rebroadcast(2);
1164 }
1165
1166 #[test]
1167 fn fake_network_test() {
1168         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1169         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1170         let chanmon_cfgs = create_chanmon_cfgs(4);
1171         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1172         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1173         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1174
1175         // Create some initial channels
1176         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1177         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1178         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1179
1180         // Rebalance the network a bit by relaying one payment through all the channels...
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         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1184         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1185
1186         // Send some more payments
1187         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
1188         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
1189         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
1190
1191         // Test failure packets
1192         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1193         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1194
1195         // Add a new channel that skips 3
1196         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1197
1198         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
1199         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
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         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1204         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1205
1206         // Do some rebalance loop payments, simultaneously
1207         let mut hops = Vec::with_capacity(3);
1208         hops.push(RouteHop {
1209                 pubkey: nodes[2].node.get_our_node_id(),
1210                 node_features: NodeFeatures::empty(),
1211                 short_channel_id: chan_2.0.contents.short_channel_id,
1212                 channel_features: ChannelFeatures::empty(),
1213                 fee_msat: 0,
1214                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1215         });
1216         hops.push(RouteHop {
1217                 pubkey: nodes[3].node.get_our_node_id(),
1218                 node_features: NodeFeatures::empty(),
1219                 short_channel_id: chan_3.0.contents.short_channel_id,
1220                 channel_features: ChannelFeatures::empty(),
1221                 fee_msat: 0,
1222                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1223         });
1224         hops.push(RouteHop {
1225                 pubkey: nodes[1].node.get_our_node_id(),
1226                 node_features: NodeFeatures::known(),
1227                 short_channel_id: chan_4.0.contents.short_channel_id,
1228                 channel_features: ChannelFeatures::known(),
1229                 fee_msat: 1000000,
1230                 cltv_expiry_delta: TEST_FINAL_CLTV,
1231         });
1232         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;
1233         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;
1234         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1235
1236         let mut hops = Vec::with_capacity(3);
1237         hops.push(RouteHop {
1238                 pubkey: nodes[3].node.get_our_node_id(),
1239                 node_features: NodeFeatures::empty(),
1240                 short_channel_id: chan_4.0.contents.short_channel_id,
1241                 channel_features: ChannelFeatures::empty(),
1242                 fee_msat: 0,
1243                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1244         });
1245         hops.push(RouteHop {
1246                 pubkey: nodes[2].node.get_our_node_id(),
1247                 node_features: NodeFeatures::empty(),
1248                 short_channel_id: chan_3.0.contents.short_channel_id,
1249                 channel_features: ChannelFeatures::empty(),
1250                 fee_msat: 0,
1251                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1252         });
1253         hops.push(RouteHop {
1254                 pubkey: nodes[1].node.get_our_node_id(),
1255                 node_features: NodeFeatures::known(),
1256                 short_channel_id: chan_2.0.contents.short_channel_id,
1257                 channel_features: ChannelFeatures::known(),
1258                 fee_msat: 1000000,
1259                 cltv_expiry_delta: TEST_FINAL_CLTV,
1260         });
1261         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;
1262         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;
1263         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1264
1265         // Claim the rebalances...
1266         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1267         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
1268
1269         // Add a duplicate new channel from 2 to 4
1270         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1271
1272         // Send some payments across both channels
1273         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1274         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1275         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1276
1277
1278         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1279         let events = nodes[0].node.get_and_clear_pending_msg_events();
1280         assert_eq!(events.len(), 0);
1281         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);
1282
1283         //TODO: Test that routes work again here as we've been notified that the channel is full
1284
1285         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
1286         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
1287         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
1288
1289         // Close down the channels...
1290         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1291         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1292         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1293         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1294         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1295 }
1296
1297 #[test]
1298 fn holding_cell_htlc_counting() {
1299         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1300         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1301         // commitment dance rounds.
1302         let chanmon_cfgs = create_chanmon_cfgs(3);
1303         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1304         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1305         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1306         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1307         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1308         let logger = test_utils::TestLogger::new();
1309
1310         let mut payments = Vec::new();
1311         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1312                 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
1313                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1314                 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();
1315                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
1316                 payments.push((payment_preimage, payment_hash));
1317         }
1318         check_added_monitors!(nodes[1], 1);
1319
1320         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1321         assert_eq!(events.len(), 1);
1322         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1323         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1324
1325         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1326         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1327         // another HTLC.
1328         let (_, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[2]);
1329         {
1330                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1331                 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();
1332                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable { ref err },
1333                         assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1334                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1335                 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1336         }
1337
1338         // This should also be true if we try to forward a payment.
1339         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[2]);
1340         {
1341                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1342                 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();
1343                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1344                 check_added_monitors!(nodes[0], 1);
1345         }
1346
1347         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1348         assert_eq!(events.len(), 1);
1349         let payment_event = SendEvent::from_event(events.pop().unwrap());
1350         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1351
1352         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1353         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1354         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1355         // fails), the second will process the resulting failure and fail the HTLC backward.
1356         expect_pending_htlcs_forwardable!(nodes[1]);
1357         expect_pending_htlcs_forwardable!(nodes[1]);
1358         check_added_monitors!(nodes[1], 1);
1359
1360         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1361         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1362         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1363
1364         let events = nodes[0].node.get_and_clear_pending_msg_events();
1365         assert_eq!(events.len(), 1);
1366         match events[0] {
1367                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1368                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1369                 },
1370                 _ => panic!("Unexpected event"),
1371         }
1372
1373         expect_payment_failed!(nodes[0], payment_hash_2, false);
1374
1375         // Now forward all the pending HTLCs and claim them back
1376         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1377         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1378         check_added_monitors!(nodes[2], 1);
1379
1380         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1381         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1382         check_added_monitors!(nodes[1], 1);
1383         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1384
1385         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1386         check_added_monitors!(nodes[1], 1);
1387         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1388
1389         for ref update in as_updates.update_add_htlcs.iter() {
1390                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1391         }
1392         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1393         check_added_monitors!(nodes[2], 1);
1394         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1395         check_added_monitors!(nodes[2], 1);
1396         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1397
1398         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1399         check_added_monitors!(nodes[1], 1);
1400         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1401         check_added_monitors!(nodes[1], 1);
1402         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1403
1404         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1405         check_added_monitors!(nodes[2], 1);
1406
1407         expect_pending_htlcs_forwardable!(nodes[2]);
1408
1409         let events = nodes[2].node.get_and_clear_pending_events();
1410         assert_eq!(events.len(), payments.len());
1411         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1412                 match event {
1413                         &Event::PaymentReceived { ref payment_hash, .. } => {
1414                                 assert_eq!(*payment_hash, *hash);
1415                         },
1416                         _ => panic!("Unexpected event"),
1417                 };
1418         }
1419
1420         for (preimage, _) in payments.drain(..) {
1421                 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1422         }
1423
1424         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1425 }
1426
1427 #[test]
1428 fn duplicate_htlc_test() {
1429         // Test that we accept duplicate payment_hash HTLCs across the network and that
1430         // claiming/failing them are all separate and don't affect each other
1431         let chanmon_cfgs = create_chanmon_cfgs(6);
1432         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1433         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1434         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1435
1436         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1437         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1438         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1439         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1440         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1441         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1442
1443         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1444
1445         *nodes[0].network_payment_count.borrow_mut() -= 1;
1446         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1447
1448         *nodes[0].network_payment_count.borrow_mut() -= 1;
1449         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1450
1451         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1452         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1453         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1454 }
1455
1456 #[test]
1457 fn test_duplicate_htlc_different_direction_onchain() {
1458         // Test that ChannelMonitor doesn't generate 2 preimage txn
1459         // when we have 2 HTLCs with same preimage that go across a node
1460         // in opposite directions, even with the same payment secret.
1461         let chanmon_cfgs = create_chanmon_cfgs(2);
1462         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1463         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1464         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1465
1466         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1467         let logger = test_utils::TestLogger::new();
1468
1469         // balancing
1470         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1471
1472         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1473
1474         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1475         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();
1476         let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
1477         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1478
1479         // Provide preimage to node 0 by claiming payment
1480         nodes[0].node.claim_funds(payment_preimage);
1481         check_added_monitors!(nodes[0], 1);
1482
1483         // Broadcast node 1 commitment txn
1484         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1485
1486         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1487         let mut has_both_htlcs = 0; // check htlcs match ones committed
1488         for outp in remote_txn[0].output.iter() {
1489                 if outp.value == 800_000 / 1000 {
1490                         has_both_htlcs += 1;
1491                 } else if outp.value == 900_000 / 1000 {
1492                         has_both_htlcs += 1;
1493                 }
1494         }
1495         assert_eq!(has_both_htlcs, 2);
1496
1497         mine_transaction(&nodes[0], &remote_txn[0]);
1498         check_added_monitors!(nodes[0], 1);
1499
1500         // Check we only broadcast 1 timeout tx
1501         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1502         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()) };
1503         assert_eq!(claim_txn.len(), 5);
1504         check_spends!(claim_txn[2], chan_1.3);
1505         check_spends!(claim_txn[3], claim_txn[2]);
1506         assert_eq!(htlc_pair.0.input.len(), 1);
1507         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1508         check_spends!(htlc_pair.0, remote_txn[0]);
1509         assert_eq!(htlc_pair.1.input.len(), 1);
1510         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1511         check_spends!(htlc_pair.1, remote_txn[0]);
1512
1513         let events = nodes[0].node.get_and_clear_pending_msg_events();
1514         assert_eq!(events.len(), 3);
1515         for e in events {
1516                 match e {
1517                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1518                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1519                                 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1520                                 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1521                         },
1522                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, .. } } => {
1523                                 assert!(update_add_htlcs.is_empty());
1524                                 assert!(update_fail_htlcs.is_empty());
1525                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1526                                 assert!(update_fail_malformed_htlcs.is_empty());
1527                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1528                         },
1529                         _ => panic!("Unexpected event"),
1530                 }
1531         }
1532 }
1533
1534 #[test]
1535 fn test_basic_channel_reserve() {
1536         let chanmon_cfgs = create_chanmon_cfgs(2);
1537         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1538         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1539         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1540         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1541         let logger = test_utils::TestLogger::new();
1542
1543         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1544         let channel_reserve = chan_stat.channel_reserve_msat;
1545
1546         // The 2* and +1 are for the fee spike reserve.
1547         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
1548         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1549         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1550         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1551         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1552         let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).err().unwrap();
1553         match err {
1554                 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1555                         match &fails[0] {
1556                                 &APIError::ChannelUnavailable{ref err} =>
1557                                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1558                                 _ => panic!("Unexpected error variant"),
1559                         }
1560                 },
1561                 _ => panic!("Unexpected error variant"),
1562         }
1563         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1564         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put our balance under counterparty-announced channel reserve value".to_string(), 1);
1565
1566         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1567 }
1568
1569 #[test]
1570 fn test_fee_spike_violation_fails_htlc() {
1571         let chanmon_cfgs = create_chanmon_cfgs(2);
1572         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1573         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1574         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1575         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1576
1577         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1578         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1579         let secp_ctx = Secp256k1::new();
1580         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1581
1582         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1583
1584         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1585         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height).unwrap();
1586         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1587         let msg = msgs::UpdateAddHTLC {
1588                 channel_id: chan.2,
1589                 htlc_id: 0,
1590                 amount_msat: htlc_msat,
1591                 payment_hash: payment_hash,
1592                 cltv_expiry: htlc_cltv,
1593                 onion_routing_packet: onion_packet,
1594         };
1595
1596         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1597
1598         // Now manually create the commitment_signed message corresponding to the update_add
1599         // nodes[0] just sent. In the code for construction of this message, "local" refers
1600         // to the sender of the message, and "remote" refers to the receiver.
1601
1602         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1603
1604         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1605
1606         // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1607         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1608         let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point) = {
1609                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1610                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1611                 let chan_signer = local_chan.get_signer();
1612                 let pubkeys = chan_signer.pubkeys();
1613                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1614                  chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1615                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx))
1616         };
1617         let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point) = {
1618                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1619                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1620                 let chan_signer = remote_chan.get_signer();
1621                 let pubkeys = chan_signer.pubkeys();
1622                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1623                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx))
1624         };
1625
1626         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1627         let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1628                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1629
1630         // Build the remote commitment transaction so we can sign it, and then later use the
1631         // signature for the commitment_signed message.
1632         let local_chan_balance = 1313;
1633
1634         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1635                 offered: false,
1636                 amount_msat: 3460001,
1637                 cltv_expiry: htlc_cltv,
1638                 payment_hash,
1639                 transaction_output_index: Some(1),
1640         };
1641
1642         let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1643
1644         let res = {
1645                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1646                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1647                 let local_chan_signer = local_chan.get_signer();
1648                 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1649                         commitment_number,
1650                         95000,
1651                         local_chan_balance,
1652                         commit_tx_keys.clone(),
1653                         feerate_per_kw,
1654                         &mut vec![(accepted_htlc_info, ())],
1655                         &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1656                 );
1657                 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1658         };
1659
1660         let commit_signed_msg = msgs::CommitmentSigned {
1661                 channel_id: chan.2,
1662                 signature: res.0,
1663                 htlc_signatures: res.1
1664         };
1665
1666         // Send the commitment_signed message to the nodes[1].
1667         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1668         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1669
1670         // Send the RAA to nodes[1].
1671         let raa_msg = msgs::RevokeAndACK {
1672                 channel_id: chan.2,
1673                 per_commitment_secret: local_secret,
1674                 next_per_commitment_point: next_local_point
1675         };
1676         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1677
1678         let events = nodes[1].node.get_and_clear_pending_msg_events();
1679         assert_eq!(events.len(), 1);
1680         // Make sure the HTLC failed in the way we expect.
1681         match events[0] {
1682                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1683                         assert_eq!(update_fail_htlcs.len(), 1);
1684                         update_fail_htlcs[0].clone()
1685                 },
1686                 _ => panic!("Unexpected event"),
1687         };
1688         nodes[1].logger.assert_log("lightning::ln::channel".to_string(), "Attempting to fail HTLC due to fee spike buffer violation".to_string(), 1);
1689
1690         check_added_monitors!(nodes[1], 2);
1691 }
1692
1693 #[test]
1694 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1695         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1696         // Set the fee rate for the channel very high, to the point where the fundee
1697         // sending any above-dust amount would result in a channel reserve violation.
1698         // In this test we check that we would be prevented from sending an HTLC in
1699         // this situation.
1700         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1701         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1702         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1703         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1704         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1705         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1706
1707         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 4843000);
1708         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1709                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1710         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1711         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);
1712 }
1713
1714 #[test]
1715 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1716         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1717         // Set the fee rate for the channel very high, to the point where the funder
1718         // receiving 1 update_add_htlc would result in them closing the channel due
1719         // to channel reserve violation. This close could also happen if the fee went
1720         // up a more realistic amount, but many HTLCs were outstanding at the time of
1721         // the update_add_htlc.
1722         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1723         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1724         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1725         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1726         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1727         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1728
1729         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1730         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1731         let secp_ctx = Secp256k1::new();
1732         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1733         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1734         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1735         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height).unwrap();
1736         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1737         let msg = msgs::UpdateAddHTLC {
1738                 channel_id: chan.2,
1739                 htlc_id: 1,
1740                 amount_msat: htlc_msat + 1,
1741                 payment_hash: payment_hash,
1742                 cltv_expiry: htlc_cltv,
1743                 onion_routing_packet: onion_packet,
1744         };
1745
1746         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1747         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1748         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);
1749         assert_eq!(nodes[0].node.list_channels().len(), 0);
1750         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1751         assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1752         check_added_monitors!(nodes[0], 1);
1753 }
1754
1755 #[test]
1756 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1757         // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1758         // calculating our commitment transaction fee (this was previously broken).
1759         let chanmon_cfgs = create_chanmon_cfgs(2);
1760         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1761         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1762         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1763
1764         // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1765         // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1766         // transaction fee with 0 HTLCs (183 sats)).
1767         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98817000, InitFeatures::known(), InitFeatures::known());
1768
1769         let dust_amt = 329000; // Dust amount
1770         // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1771         // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1772         // commitment transaction fee.
1773         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1774 }
1775
1776 #[test]
1777 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1778         // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1779         // calculating our counterparty's commitment transaction fee (this was previously broken).
1780         let chanmon_cfgs = create_chanmon_cfgs(2);
1781         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1782         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1783         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1784         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1785
1786         let payment_amt = 46000; // Dust amount
1787         // In the previous code, these first four payments would succeed.
1788         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1789         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1790         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1791         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1792
1793         // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
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         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1798         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1799
1800         // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1801         // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1802         // transaction fee and therefore perceived this next payment as a channel reserve violation.
1803         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1804 }
1805
1806 #[test]
1807 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1808         let chanmon_cfgs = create_chanmon_cfgs(3);
1809         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1810         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1811         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1812         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1813         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1814
1815         let feemsat = 239;
1816         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1817         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1818         let feerate = get_feerate!(nodes[0], chan.2);
1819
1820         // Add a 2* and +1 for the fee spike reserve.
1821         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1822         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;
1823         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1824
1825         // Add a pending HTLC.
1826         let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1827         let payment_event_1 = {
1828                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1829                 check_added_monitors!(nodes[0], 1);
1830
1831                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1832                 assert_eq!(events.len(), 1);
1833                 SendEvent::from_event(events.remove(0))
1834         };
1835         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1836
1837         // Attempt to trigger a channel reserve violation --> payment failure.
1838         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1839         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;
1840         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1841         let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1842
1843         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1844         let secp_ctx = Secp256k1::new();
1845         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1846         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1847         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1848         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1849         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1850         let msg = msgs::UpdateAddHTLC {
1851                 channel_id: chan.2,
1852                 htlc_id: 1,
1853                 amount_msat: htlc_msat + 1,
1854                 payment_hash: our_payment_hash_1,
1855                 cltv_expiry: htlc_cltv,
1856                 onion_routing_packet: onion_packet,
1857         };
1858
1859         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1860         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1861         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1862         assert_eq!(nodes[1].node.list_channels().len(), 1);
1863         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1864         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1865         check_added_monitors!(nodes[1], 1);
1866 }
1867
1868 #[test]
1869 fn test_inbound_outbound_capacity_is_not_zero() {
1870         let chanmon_cfgs = create_chanmon_cfgs(2);
1871         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1872         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1873         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1874         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1875         let channels0 = node_chanmgrs[0].list_channels();
1876         let channels1 = node_chanmgrs[1].list_channels();
1877         assert_eq!(channels0.len(), 1);
1878         assert_eq!(channels1.len(), 1);
1879
1880         assert_eq!(channels0[0].inbound_capacity_msat, 95000000);
1881         assert_eq!(channels1[0].outbound_capacity_msat, 95000000);
1882
1883         assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000);
1884         assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000);
1885 }
1886
1887 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1888         (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1889 }
1890
1891 #[test]
1892 fn test_channel_reserve_holding_cell_htlcs() {
1893         let chanmon_cfgs = create_chanmon_cfgs(3);
1894         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1895         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1896         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1897         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1898         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1899
1900         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1901         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1902
1903         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1904         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1905
1906         macro_rules! expect_forward {
1907                 ($node: expr) => {{
1908                         let mut events = $node.node.get_and_clear_pending_msg_events();
1909                         assert_eq!(events.len(), 1);
1910                         check_added_monitors!($node, 1);
1911                         let payment_event = SendEvent::from_event(events.remove(0));
1912                         payment_event
1913                 }}
1914         }
1915
1916         let feemsat = 239; // somehow we know?
1917         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1918         let feerate = get_feerate!(nodes[0], chan_1.2);
1919
1920         let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1921
1922         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1923         {
1924                 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1925                 route.paths[0].last_mut().unwrap().fee_msat += 1;
1926                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1927                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1928                         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)));
1929                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1930                 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);
1931         }
1932
1933         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1934         // nodes[0]'s wealth
1935         loop {
1936                 let amt_msat = recv_value_0 + total_fee_msat;
1937                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1938                 // Also, ensure that each payment has enough to be over the dust limit to
1939                 // ensure it'll be included in each commit tx fee calculation.
1940                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1941                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1942                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1943                         break;
1944                 }
1945                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1946
1947                 let (stat01_, stat11_, stat12_, stat22_) = (
1948                         get_channel_value_stat!(nodes[0], chan_1.2),
1949                         get_channel_value_stat!(nodes[1], chan_1.2),
1950                         get_channel_value_stat!(nodes[1], chan_2.2),
1951                         get_channel_value_stat!(nodes[2], chan_2.2),
1952                 );
1953
1954                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1955                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1956                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1957                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1958                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1959         }
1960
1961         // adding pending output.
1962         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1963         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1964         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1965         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1966         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1967         // cases where 1 msat over X amount will cause a payment failure, but anything less than
1968         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1969         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1970         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1971         // policy.
1972         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1973         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1974         let amt_msat_1 = recv_value_1 + total_fee_msat;
1975
1976         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);
1977         let payment_event_1 = {
1978                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1979                 check_added_monitors!(nodes[0], 1);
1980
1981                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1982                 assert_eq!(events.len(), 1);
1983                 SendEvent::from_event(events.remove(0))
1984         };
1985         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1986
1987         // channel reserve test with htlc pending output > 0
1988         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1989         {
1990                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
1991                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1992                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1993                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1994         }
1995
1996         // split the rest to test holding cell
1997         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1998         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
1999         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2000         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2001         {
2002                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2003                 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);
2004         }
2005
2006         // now see if they go through on both sides
2007         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);
2008         // but this will stuck in the holding cell
2009         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
2010         check_added_monitors!(nodes[0], 0);
2011         let events = nodes[0].node.get_and_clear_pending_events();
2012         assert_eq!(events.len(), 0);
2013
2014         // test with outbound holding cell amount > 0
2015         {
2016                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
2017                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2018                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2019                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2020                 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);
2021         }
2022
2023         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);
2024         // this will also stuck in the holding cell
2025         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
2026         check_added_monitors!(nodes[0], 0);
2027         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2028         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2029
2030         // flush the pending htlc
2031         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2032         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2033         check_added_monitors!(nodes[1], 1);
2034
2035         // the pending htlc should be promoted to committed
2036         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2037         check_added_monitors!(nodes[0], 1);
2038         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2039
2040         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2041         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2042         // No commitment_signed so get_event_msg's assert(len == 1) passes
2043         check_added_monitors!(nodes[0], 1);
2044
2045         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2046         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2047         check_added_monitors!(nodes[1], 1);
2048
2049         expect_pending_htlcs_forwardable!(nodes[1]);
2050
2051         let ref payment_event_11 = expect_forward!(nodes[1]);
2052         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2053         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2054
2055         expect_pending_htlcs_forwardable!(nodes[2]);
2056         expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
2057
2058         // flush the htlcs in the holding cell
2059         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2060         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2061         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2062         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2063         expect_pending_htlcs_forwardable!(nodes[1]);
2064
2065         let ref payment_event_3 = expect_forward!(nodes[1]);
2066         assert_eq!(payment_event_3.msgs.len(), 2);
2067         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2068         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2069
2070         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2071         expect_pending_htlcs_forwardable!(nodes[2]);
2072
2073         let events = nodes[2].node.get_and_clear_pending_events();
2074         assert_eq!(events.len(), 2);
2075         match events[0] {
2076                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2077                         assert_eq!(our_payment_hash_21, *payment_hash);
2078                         assert!(payment_preimage.is_none());
2079                         assert_eq!(our_payment_secret_21, *payment_secret);
2080                         assert_eq!(recv_value_21, amt);
2081                 },
2082                 _ => panic!("Unexpected event"),
2083         }
2084         match events[1] {
2085                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2086                         assert_eq!(our_payment_hash_22, *payment_hash);
2087                         assert!(payment_preimage.is_none());
2088                         assert_eq!(our_payment_secret_22, *payment_secret);
2089                         assert_eq!(recv_value_22, amt);
2090                 },
2091                 _ => panic!("Unexpected event"),
2092         }
2093
2094         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
2095         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
2096         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
2097
2098         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2099         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2100         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
2101
2102         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2103         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);
2104         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2105         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2106         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2107
2108         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2109         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2110 }
2111
2112 #[test]
2113 fn channel_reserve_in_flight_removes() {
2114         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2115         // can send to its counterparty, but due to update ordering, the other side may not yet have
2116         // considered those HTLCs fully removed.
2117         // This tests that we don't count HTLCs which will not be included in the next remote
2118         // commitment transaction towards the reserve value (as it implies no commitment transaction
2119         // will be generated which violates the remote reserve value).
2120         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2121         // To test this we:
2122         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2123         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2124         //    you only consider the value of the first HTLC, it may not),
2125         //  * start routing a third HTLC from A to B,
2126         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2127         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2128         //  * deliver the first fulfill from B
2129         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2130         //    claim,
2131         //  * deliver A's response CS and RAA.
2132         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2133         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
2134         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2135         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2136         let chanmon_cfgs = create_chanmon_cfgs(2);
2137         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2138         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2139         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2140         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2141         let logger = test_utils::TestLogger::new();
2142
2143         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2144         // Route the first two HTLCs.
2145         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2146         let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2147
2148         // Start routing the third HTLC (this is just used to get everyone in the right state).
2149         let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
2150         let send_1 = {
2151                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2152                 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();
2153                 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
2154                 check_added_monitors!(nodes[0], 1);
2155                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2156                 assert_eq!(events.len(), 1);
2157                 SendEvent::from_event(events.remove(0))
2158         };
2159
2160         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2161         // initial fulfill/CS.
2162         assert!(nodes[1].node.claim_funds(payment_preimage_1));
2163         check_added_monitors!(nodes[1], 1);
2164         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2165
2166         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2167         // remove the second HTLC when we send the HTLC back from B to A.
2168         assert!(nodes[1].node.claim_funds(payment_preimage_2));
2169         check_added_monitors!(nodes[1], 1);
2170         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2171
2172         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2173         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2174         check_added_monitors!(nodes[0], 1);
2175         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2176         expect_payment_sent!(nodes[0], payment_preimage_1);
2177
2178         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2179         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2180         check_added_monitors!(nodes[1], 1);
2181         // B is already AwaitingRAA, so cant generate a CS here
2182         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2183
2184         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2185         check_added_monitors!(nodes[1], 1);
2186         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2187
2188         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2189         check_added_monitors!(nodes[0], 1);
2190         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2191
2192         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2193         check_added_monitors!(nodes[1], 1);
2194         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2195
2196         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2197         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2198         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2199         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2200         // on-chain as necessary).
2201         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2202         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2203         check_added_monitors!(nodes[0], 1);
2204         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2205         expect_payment_sent!(nodes[0], payment_preimage_2);
2206
2207         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2208         check_added_monitors!(nodes[1], 1);
2209         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2210
2211         expect_pending_htlcs_forwardable!(nodes[1]);
2212         expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
2213
2214         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2215         // resolve the second HTLC from A's point of view.
2216         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2217         check_added_monitors!(nodes[0], 1);
2218         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2219
2220         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2221         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2222         let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
2223         let send_2 = {
2224                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2225                 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();
2226                 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
2227                 check_added_monitors!(nodes[1], 1);
2228                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2229                 assert_eq!(events.len(), 1);
2230                 SendEvent::from_event(events.remove(0))
2231         };
2232
2233         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2234         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2235         check_added_monitors!(nodes[0], 1);
2236         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2237
2238         // Now just resolve all the outstanding messages/HTLCs for completeness...
2239
2240         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2241         check_added_monitors!(nodes[1], 1);
2242         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2243
2244         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2245         check_added_monitors!(nodes[1], 1);
2246
2247         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2248         check_added_monitors!(nodes[0], 1);
2249         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2250
2251         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2252         check_added_monitors!(nodes[1], 1);
2253         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2254
2255         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2256         check_added_monitors!(nodes[0], 1);
2257
2258         expect_pending_htlcs_forwardable!(nodes[0]);
2259         expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2260
2261         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2262         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2263 }
2264
2265 #[test]
2266 fn channel_monitor_network_test() {
2267         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2268         // tests that ChannelMonitor is able to recover from various states.
2269         let chanmon_cfgs = create_chanmon_cfgs(5);
2270         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2271         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2272         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2273
2274         // Create some initial channels
2275         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2276         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2277         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2278         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2279
2280         // Make sure all nodes are at the same starting height
2281         connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2282         connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2283         connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2284         connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2285         connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2286
2287         // Rebalance the network a bit by relaying one payment through all the channels...
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         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2291         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2292
2293         // Simple case with no pending HTLCs:
2294         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2295         check_added_monitors!(nodes[1], 1);
2296         check_closed_broadcast!(nodes[1], false);
2297         {
2298                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2299                 assert_eq!(node_txn.len(), 1);
2300                 mine_transaction(&nodes[0], &node_txn[0]);
2301                 check_added_monitors!(nodes[0], 1);
2302                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2303         }
2304         check_closed_broadcast!(nodes[0], true);
2305         assert_eq!(nodes[0].node.list_channels().len(), 0);
2306         assert_eq!(nodes[1].node.list_channels().len(), 1);
2307
2308         // One pending HTLC is discarded by the force-close:
2309         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2310
2311         // Simple case of one pending HTLC to HTLC-Timeout
2312         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2313         check_closed_broadcast!(nodes[1], false);
2314         check_added_monitors!(nodes[1], 1);
2315         {
2316                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2317                 mine_transaction(&nodes[2], &node_txn[0]);
2318                 check_added_monitors!(nodes[2], 1);
2319                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2320         }
2321         check_closed_broadcast!(nodes[2], true);
2322         assert_eq!(nodes[1].node.list_channels().len(), 0);
2323         assert_eq!(nodes[2].node.list_channels().len(), 1);
2324
2325         macro_rules! claim_funds {
2326                 ($node: expr, $prev_node: expr, $preimage: expr) => {
2327                         {
2328                                 assert!($node.node.claim_funds($preimage));
2329                                 check_added_monitors!($node, 1);
2330
2331                                 let events = $node.node.get_and_clear_pending_msg_events();
2332                                 assert_eq!(events.len(), 1);
2333                                 match events[0] {
2334                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2335                                                 assert!(update_add_htlcs.is_empty());
2336                                                 assert!(update_fail_htlcs.is_empty());
2337                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2338                                         },
2339                                         _ => panic!("Unexpected event"),
2340                                 };
2341                         }
2342                 }
2343         }
2344
2345         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2346         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2347         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2348         check_added_monitors!(nodes[2], 1);
2349         check_closed_broadcast!(nodes[2], false);
2350         let node2_commitment_txid;
2351         {
2352                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2353                 node2_commitment_txid = node_txn[0].txid();
2354
2355                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2356                 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2357                 mine_transaction(&nodes[3], &node_txn[0]);
2358                 check_added_monitors!(nodes[3], 1);
2359                 check_preimage_claim(&nodes[3], &node_txn);
2360         }
2361         check_closed_broadcast!(nodes[3], true);
2362         assert_eq!(nodes[2].node.list_channels().len(), 0);
2363         assert_eq!(nodes[3].node.list_channels().len(), 1);
2364
2365         // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2366         // confusing us in the following tests.
2367         let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2368
2369         // One pending HTLC to time out:
2370         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2371         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2372         // buffer space).
2373
2374         let (close_chan_update_1, close_chan_update_2) = {
2375                 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2376                 let events = nodes[3].node.get_and_clear_pending_msg_events();
2377                 assert_eq!(events.len(), 2);
2378                 let close_chan_update_1 = match events[0] {
2379                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2380                                 msg.clone()
2381                         },
2382                         _ => panic!("Unexpected event"),
2383                 };
2384                 match events[1] {
2385                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2386                                 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2387                         },
2388                         _ => panic!("Unexpected event"),
2389                 }
2390                 check_added_monitors!(nodes[3], 1);
2391
2392                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2393                 {
2394                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2395                         node_txn.retain(|tx| {
2396                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2397                                         false
2398                                 } else { true }
2399                         });
2400                 }
2401
2402                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2403
2404                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2405                 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2406
2407                 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2408                 let events = nodes[4].node.get_and_clear_pending_msg_events();
2409                 assert_eq!(events.len(), 2);
2410                 let close_chan_update_2 = match events[0] {
2411                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2412                                 msg.clone()
2413                         },
2414                         _ => panic!("Unexpected event"),
2415                 };
2416                 match events[1] {
2417                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2418                                 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2419                         },
2420                         _ => panic!("Unexpected event"),
2421                 }
2422                 check_added_monitors!(nodes[4], 1);
2423                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2424
2425                 mine_transaction(&nodes[4], &node_txn[0]);
2426                 check_preimage_claim(&nodes[4], &node_txn);
2427                 (close_chan_update_1, close_chan_update_2)
2428         };
2429         nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2430         nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2431         assert_eq!(nodes[3].node.list_channels().len(), 0);
2432         assert_eq!(nodes[4].node.list_channels().len(), 0);
2433
2434         nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2435 }
2436
2437 #[test]
2438 fn test_justice_tx() {
2439         // Test justice txn built on revoked HTLC-Success tx, against both sides
2440         let mut alice_config = UserConfig::default();
2441         alice_config.channel_options.announced_channel = true;
2442         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2443         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2444         let mut bob_config = UserConfig::default();
2445         bob_config.channel_options.announced_channel = true;
2446         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2447         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2448         let user_cfgs = [Some(alice_config), Some(bob_config)];
2449         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2450         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2451         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2452         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2453         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2454         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2455         // Create some new channels:
2456         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2457
2458         // A pending HTLC which will be revoked:
2459         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2460         // Get the will-be-revoked local txn from nodes[0]
2461         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2462         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2463         assert_eq!(revoked_local_txn[0].input.len(), 1);
2464         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2465         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2466         assert_eq!(revoked_local_txn[1].input.len(), 1);
2467         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2468         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2469         // Revoke the old state
2470         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2471
2472         {
2473                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2474                 {
2475                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2476                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2477                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2478
2479                         check_spends!(node_txn[0], revoked_local_txn[0]);
2480                         node_txn.swap_remove(0);
2481                         node_txn.truncate(1);
2482                 }
2483                 check_added_monitors!(nodes[1], 1);
2484                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2485
2486                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2487                 // Verify broadcast of revoked HTLC-timeout
2488                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2489                 check_added_monitors!(nodes[0], 1);
2490                 // Broadcast revoked HTLC-timeout on node 1
2491                 mine_transaction(&nodes[1], &node_txn[1]);
2492                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2493         }
2494         get_announce_close_broadcast_events(&nodes, 0, 1);
2495
2496         assert_eq!(nodes[0].node.list_channels().len(), 0);
2497         assert_eq!(nodes[1].node.list_channels().len(), 0);
2498
2499         // We test justice_tx build by A on B's revoked HTLC-Success tx
2500         // Create some new channels:
2501         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2502         {
2503                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2504                 node_txn.clear();
2505         }
2506
2507         // A pending HTLC which will be revoked:
2508         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2509         // Get the will-be-revoked local txn from B
2510         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2511         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2512         assert_eq!(revoked_local_txn[0].input.len(), 1);
2513         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2514         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2515         // Revoke the old state
2516         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2517         {
2518                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2519                 {
2520                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2521                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2522                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2523
2524                         check_spends!(node_txn[0], revoked_local_txn[0]);
2525                         node_txn.swap_remove(0);
2526                 }
2527                 check_added_monitors!(nodes[0], 1);
2528                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2529
2530                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2531                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2532                 check_added_monitors!(nodes[1], 1);
2533                 mine_transaction(&nodes[0], &node_txn[1]);
2534                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2535         }
2536         get_announce_close_broadcast_events(&nodes, 0, 1);
2537         assert_eq!(nodes[0].node.list_channels().len(), 0);
2538         assert_eq!(nodes[1].node.list_channels().len(), 0);
2539 }
2540
2541 #[test]
2542 fn revoked_output_claim() {
2543         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2544         // transaction is broadcast by its counterparty
2545         let chanmon_cfgs = create_chanmon_cfgs(2);
2546         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2547         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2548         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2549         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2550         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2551         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2552         assert_eq!(revoked_local_txn.len(), 1);
2553         // Only output is the full channel value back to nodes[0]:
2554         assert_eq!(revoked_local_txn[0].output.len(), 1);
2555         // Send a payment through, updating everyone's latest commitment txn
2556         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2557
2558         // Inform nodes[1] that nodes[0] broadcast a stale tx
2559         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2560         check_added_monitors!(nodes[1], 1);
2561         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2562         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2563
2564         check_spends!(node_txn[0], revoked_local_txn[0]);
2565         check_spends!(node_txn[1], chan_1.3);
2566
2567         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2568         mine_transaction(&nodes[0], &revoked_local_txn[0]);
2569         get_announce_close_broadcast_events(&nodes, 0, 1);
2570         check_added_monitors!(nodes[0], 1)
2571 }
2572
2573 #[test]
2574 fn claim_htlc_outputs_shared_tx() {
2575         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2576         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2577         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2578         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2579         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2580         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2581
2582         // Create some new channel:
2583         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2584
2585         // Rebalance the network to generate htlc in the two directions
2586         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2587         // 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
2588         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2589         let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2590
2591         // Get the will-be-revoked local txn from node[0]
2592         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2593         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2594         assert_eq!(revoked_local_txn[0].input.len(), 1);
2595         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2596         assert_eq!(revoked_local_txn[1].input.len(), 1);
2597         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2598         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2599         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2600
2601         //Revoke the old state
2602         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2603
2604         {
2605                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2606                 check_added_monitors!(nodes[0], 1);
2607                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2608                 check_added_monitors!(nodes[1], 1);
2609                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2610                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2611
2612                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2613                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2614
2615                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2616                 check_spends!(node_txn[0], revoked_local_txn[0]);
2617
2618                 let mut witness_lens = BTreeSet::new();
2619                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2620                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2621                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2622                 assert_eq!(witness_lens.len(), 3);
2623                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2624                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2625                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2626
2627                 // Next nodes[1] broadcasts its current local tx state:
2628                 assert_eq!(node_txn[1].input.len(), 1);
2629                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2630
2631                 assert_eq!(node_txn[2].input.len(), 1);
2632                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2633                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2634                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2635                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2636                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2637         }
2638         get_announce_close_broadcast_events(&nodes, 0, 1);
2639         assert_eq!(nodes[0].node.list_channels().len(), 0);
2640         assert_eq!(nodes[1].node.list_channels().len(), 0);
2641 }
2642
2643 #[test]
2644 fn claim_htlc_outputs_single_tx() {
2645         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2646         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2647         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2648         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2649         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2650         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2651
2652         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2653
2654         // Rebalance the network to generate htlc in the two directions
2655         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2656         // node[0] is gonna to revoke an old state thus node[1] should be able to claim both offered/received HTLC outputs on top of commitment tx, but this
2657         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2658         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2659         let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2660
2661         // Get the will-be-revoked local txn from node[0]
2662         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2663
2664         //Revoke the old state
2665         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2666
2667         {
2668                 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2669                 check_added_monitors!(nodes[0], 1);
2670                 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2671                 check_added_monitors!(nodes[1], 1);
2672                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2673
2674                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2675                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2676
2677                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2678                 assert_eq!(node_txn.len(), 9);
2679                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2680                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2681                 // ChannelMonitor: bumped justice tx, after one increase, bumps on HTLC aren't generated not being substantial anymore, bump on revoked to_local isn't generated due to more room for expiration (2)
2682                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2683
2684                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2685                 assert_eq!(node_txn[0].input.len(), 1);
2686                 check_spends!(node_txn[0], chan_1.3);
2687                 assert_eq!(node_txn[1].input.len(), 1);
2688                 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2689                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2690                 check_spends!(node_txn[1], node_txn[0]);
2691
2692                 // Justice transactions are indices 1-2-4
2693                 assert_eq!(node_txn[2].input.len(), 1);
2694                 assert_eq!(node_txn[3].input.len(), 1);
2695                 assert_eq!(node_txn[4].input.len(), 1);
2696
2697                 check_spends!(node_txn[2], revoked_local_txn[0]);
2698                 check_spends!(node_txn[3], revoked_local_txn[0]);
2699                 check_spends!(node_txn[4], revoked_local_txn[0]);
2700
2701                 let mut witness_lens = BTreeSet::new();
2702                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2703                 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2704                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2705                 assert_eq!(witness_lens.len(), 3);
2706                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2707                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2708                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2709         }
2710         get_announce_close_broadcast_events(&nodes, 0, 1);
2711         assert_eq!(nodes[0].node.list_channels().len(), 0);
2712         assert_eq!(nodes[1].node.list_channels().len(), 0);
2713 }
2714
2715 #[test]
2716 fn test_htlc_on_chain_success() {
2717         // Test that in case of a unilateral close onchain, we detect the state of output and pass
2718         // the preimage backward accordingly. So here we test that ChannelManager is
2719         // broadcasting the right event to other nodes in payment path.
2720         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2721         // A --------------------> B ----------------------> C (preimage)
2722         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2723         // commitment transaction was broadcast.
2724         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2725         // towards B.
2726         // B should be able to claim via preimage if A then broadcasts its local tx.
2727         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2728         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2729         // PaymentSent event).
2730
2731         let chanmon_cfgs = create_chanmon_cfgs(3);
2732         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2733         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2734         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2735
2736         // Create some initial channels
2737         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2738         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2739
2740         // Rebalance the network a bit by relaying one payment through all the channels...
2741         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2742         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2743
2744         let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2745         let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2746
2747         // Broadcast legit commitment tx from C on B's chain
2748         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2749         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2750         assert_eq!(commitment_tx.len(), 1);
2751         check_spends!(commitment_tx[0], chan_2.3);
2752         nodes[2].node.claim_funds(our_payment_preimage);
2753         nodes[2].node.claim_funds(our_payment_preimage_2);
2754         check_added_monitors!(nodes[2], 2);
2755         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2756         assert!(updates.update_add_htlcs.is_empty());
2757         assert!(updates.update_fail_htlcs.is_empty());
2758         assert!(updates.update_fail_malformed_htlcs.is_empty());
2759         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2760
2761         mine_transaction(&nodes[2], &commitment_tx[0]);
2762         check_closed_broadcast!(nodes[2], true);
2763         check_added_monitors!(nodes[2], 1);
2764         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)
2765         assert_eq!(node_txn.len(), 5);
2766         assert_eq!(node_txn[0], node_txn[3]);
2767         assert_eq!(node_txn[1], node_txn[4]);
2768         assert_eq!(node_txn[2], commitment_tx[0]);
2769         check_spends!(node_txn[0], commitment_tx[0]);
2770         check_spends!(node_txn[1], commitment_tx[0]);
2771         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2772         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2773         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2774         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2775         assert_eq!(node_txn[0].lock_time, 0);
2776         assert_eq!(node_txn[1].lock_time, 0);
2777
2778         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2779         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2780         connect_block(&nodes[1], &Block { header, txdata: node_txn});
2781         {
2782                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2783                 assert_eq!(added_monitors.len(), 1);
2784                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2785                 added_monitors.clear();
2786         }
2787         let events = nodes[1].node.get_and_clear_pending_msg_events();
2788         {
2789                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2790                 assert_eq!(added_monitors.len(), 2);
2791                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2792                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2793                 added_monitors.clear();
2794         }
2795         assert_eq!(events.len(), 3);
2796         match events[0] {
2797                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2798                 _ => panic!("Unexpected event"),
2799         }
2800         match events[1] {
2801                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2802                 _ => panic!("Unexpected event"),
2803         }
2804
2805         match events[2] {
2806                 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, .. } } => {
2807                         assert!(update_add_htlcs.is_empty());
2808                         assert!(update_fail_htlcs.is_empty());
2809                         assert_eq!(update_fulfill_htlcs.len(), 1);
2810                         assert!(update_fail_malformed_htlcs.is_empty());
2811                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2812                 },
2813                 _ => panic!("Unexpected event"),
2814         };
2815         macro_rules! check_tx_local_broadcast {
2816                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2817                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2818                         assert_eq!(node_txn.len(), 5);
2819                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2820                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2821                         check_spends!(node_txn[0], $commitment_tx);
2822                         check_spends!(node_txn[1], $commitment_tx);
2823                         assert_ne!(node_txn[0].lock_time, 0);
2824                         assert_ne!(node_txn[1].lock_time, 0);
2825                         if $htlc_offered {
2826                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2827                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2828                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2829                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2830                         } else {
2831                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2832                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2833                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2834                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2835                         }
2836                         check_spends!(node_txn[2], $chan_tx);
2837                         check_spends!(node_txn[3], node_txn[2]);
2838                         check_spends!(node_txn[4], node_txn[2]);
2839                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2840                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2841                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2842                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2843                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2844                         assert_ne!(node_txn[3].lock_time, 0);
2845                         assert_ne!(node_txn[4].lock_time, 0);
2846                         node_txn.clear();
2847                 } }
2848         }
2849         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2850         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2851         // timeout-claim of the output that nodes[2] just claimed via success.
2852         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2853
2854         // Broadcast legit commitment tx from A on B's chain
2855         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2856         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2857         check_spends!(commitment_tx[0], chan_1.3);
2858         mine_transaction(&nodes[1], &commitment_tx[0]);
2859         check_closed_broadcast!(nodes[1], true);
2860         check_added_monitors!(nodes[1], 1);
2861         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2862         assert_eq!(node_txn.len(), 4);
2863         check_spends!(node_txn[0], commitment_tx[0]);
2864         assert_eq!(node_txn[0].input.len(), 2);
2865         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2866         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2867         assert_eq!(node_txn[0].lock_time, 0);
2868         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2869         check_spends!(node_txn[1], chan_1.3);
2870         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2871         check_spends!(node_txn[2], node_txn[1]);
2872         check_spends!(node_txn[3], node_txn[1]);
2873         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2874         // we already checked the same situation with A.
2875
2876         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2877         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2878         connect_block(&nodes[0], &Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] });
2879         check_closed_broadcast!(nodes[0], true);
2880         check_added_monitors!(nodes[0], 1);
2881         let events = nodes[0].node.get_and_clear_pending_events();
2882         assert_eq!(events.len(), 2);
2883         let mut first_claimed = false;
2884         for event in events {
2885                 match event {
2886                         Event::PaymentSent { payment_preimage } => {
2887                                 if payment_preimage == our_payment_preimage {
2888                                         assert!(!first_claimed);
2889                                         first_claimed = true;
2890                                 } else {
2891                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2892                                 }
2893                         },
2894                         _ => panic!("Unexpected event"),
2895                 }
2896         }
2897         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2898 }
2899
2900 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2901         // Test that in case of a unilateral close onchain, we detect the state of output and
2902         // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2903         // broadcasting the right event to other nodes in payment path.
2904         // A ------------------> B ----------------------> C (timeout)
2905         //    B's commitment tx                 C's commitment tx
2906         //            \                                  \
2907         //         B's HTLC timeout tx               B's timeout tx
2908
2909         let chanmon_cfgs = create_chanmon_cfgs(3);
2910         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2911         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2912         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2913         *nodes[0].connect_style.borrow_mut() = connect_style;
2914         *nodes[1].connect_style.borrow_mut() = connect_style;
2915         *nodes[2].connect_style.borrow_mut() = connect_style;
2916
2917         // Create some intial channels
2918         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2919         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2920
2921         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2922         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2923         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2924
2925         let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2926
2927         // Broadcast legit commitment tx from C on B's chain
2928         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2929         check_spends!(commitment_tx[0], chan_2.3);
2930         nodes[2].node.fail_htlc_backwards(&payment_hash);
2931         check_added_monitors!(nodes[2], 0);
2932         expect_pending_htlcs_forwardable!(nodes[2]);
2933         check_added_monitors!(nodes[2], 1);
2934
2935         let events = nodes[2].node.get_and_clear_pending_msg_events();
2936         assert_eq!(events.len(), 1);
2937         match events[0] {
2938                 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, .. } } => {
2939                         assert!(update_add_htlcs.is_empty());
2940                         assert!(!update_fail_htlcs.is_empty());
2941                         assert!(update_fulfill_htlcs.is_empty());
2942                         assert!(update_fail_malformed_htlcs.is_empty());
2943                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2944                 },
2945                 _ => panic!("Unexpected event"),
2946         };
2947         mine_transaction(&nodes[2], &commitment_tx[0]);
2948         check_closed_broadcast!(nodes[2], true);
2949         check_added_monitors!(nodes[2], 1);
2950         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2951         assert_eq!(node_txn.len(), 1);
2952         check_spends!(node_txn[0], chan_2.3);
2953         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2954
2955         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2956         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2957         connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2958         mine_transaction(&nodes[1], &commitment_tx[0]);
2959         let timeout_tx;
2960         {
2961                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2962                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2963                 assert_eq!(node_txn[0], node_txn[3]);
2964                 assert_eq!(node_txn[1], node_txn[4]);
2965
2966                 check_spends!(node_txn[2], commitment_tx[0]);
2967                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2968
2969                 check_spends!(node_txn[0], chan_2.3);
2970                 check_spends!(node_txn[1], node_txn[0]);
2971                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2972                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2973
2974                 timeout_tx = node_txn[2].clone();
2975                 node_txn.clear();
2976         }
2977
2978         mine_transaction(&nodes[1], &timeout_tx);
2979         check_added_monitors!(nodes[1], 1);
2980         check_closed_broadcast!(nodes[1], true);
2981         {
2982                 // B will rebroadcast a fee-bumped timeout transaction here.
2983                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2984                 assert_eq!(node_txn.len(), 1);
2985                 check_spends!(node_txn[0], commitment_tx[0]);
2986         }
2987
2988         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2989         {
2990                 // B will rebroadcast its own holder commitment transaction here...just because
2991                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2992                 assert_eq!(node_txn.len(), 1);
2993                 check_spends!(node_txn[0], chan_2.3);
2994         }
2995
2996         expect_pending_htlcs_forwardable!(nodes[1]);
2997         check_added_monitors!(nodes[1], 1);
2998         let events = nodes[1].node.get_and_clear_pending_msg_events();
2999         assert_eq!(events.len(), 1);
3000         match events[0] {
3001                 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, .. } } => {
3002                         assert!(update_add_htlcs.is_empty());
3003                         assert!(!update_fail_htlcs.is_empty());
3004                         assert!(update_fulfill_htlcs.is_empty());
3005                         assert!(update_fail_malformed_htlcs.is_empty());
3006                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3007                 },
3008                 _ => panic!("Unexpected event"),
3009         };
3010
3011         // Broadcast legit commitment tx from B on A's chain
3012         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3013         check_spends!(commitment_tx[0], chan_1.3);
3014
3015         mine_transaction(&nodes[0], &commitment_tx[0]);
3016
3017         check_closed_broadcast!(nodes[0], true);
3018         check_added_monitors!(nodes[0], 1);
3019         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
3020         assert_eq!(node_txn.len(), 3);
3021         check_spends!(node_txn[0], commitment_tx[0]);
3022         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3023         check_spends!(node_txn[1], chan_1.3);
3024         check_spends!(node_txn[2], node_txn[1]);
3025         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
3026         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3027 }
3028
3029 #[test]
3030 fn test_htlc_on_chain_timeout() {
3031         do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
3032         do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
3033         do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
3034 }
3035
3036 #[test]
3037 fn test_simple_commitment_revoked_fail_backward() {
3038         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3039         // and fail backward accordingly.
3040
3041         let chanmon_cfgs = create_chanmon_cfgs(3);
3042         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3043         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3044         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3045
3046         // Create some initial channels
3047         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3048         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3049
3050         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3051         // Get the will-be-revoked local txn from nodes[2]
3052         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3053         // Revoke the old state
3054         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3055
3056         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3057
3058         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3059         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3060         check_added_monitors!(nodes[1], 1);
3061         check_closed_broadcast!(nodes[1], true);
3062
3063         expect_pending_htlcs_forwardable!(nodes[1]);
3064         check_added_monitors!(nodes[1], 1);
3065         let events = nodes[1].node.get_and_clear_pending_msg_events();
3066         assert_eq!(events.len(), 1);
3067         match events[0] {
3068                 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, .. } } => {
3069                         assert!(update_add_htlcs.is_empty());
3070                         assert_eq!(update_fail_htlcs.len(), 1);
3071                         assert!(update_fulfill_htlcs.is_empty());
3072                         assert!(update_fail_malformed_htlcs.is_empty());
3073                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3074
3075                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3076                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3077
3078                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3079                         assert_eq!(events.len(), 1);
3080                         match events[0] {
3081                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3082                                 _ => panic!("Unexpected event"),
3083                         }
3084                         expect_payment_failed!(nodes[0], payment_hash, false);
3085                 },
3086                 _ => panic!("Unexpected event"),
3087         }
3088 }
3089
3090 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3091         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3092         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3093         // commitment transaction anymore.
3094         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3095         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3096         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3097         // technically disallowed and we should probably handle it reasonably.
3098         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3099         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3100         // transactions:
3101         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3102         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3103         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3104         //   and once they revoke the previous commitment transaction (allowing us to send a new
3105         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3106         let chanmon_cfgs = create_chanmon_cfgs(3);
3107         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3108         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3109         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3110
3111         // Create some initial channels
3112         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3113         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3114
3115         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 });
3116         // Get the will-be-revoked local txn from nodes[2]
3117         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3118         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3119         // Revoke the old state
3120         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3121
3122         let value = if use_dust {
3123                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3124                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3125                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3126         } else { 3000000 };
3127
3128         let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3129         let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3130         let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3131
3132         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
3133         expect_pending_htlcs_forwardable!(nodes[2]);
3134         check_added_monitors!(nodes[2], 1);
3135         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3136         assert!(updates.update_add_htlcs.is_empty());
3137         assert!(updates.update_fulfill_htlcs.is_empty());
3138         assert!(updates.update_fail_malformed_htlcs.is_empty());
3139         assert_eq!(updates.update_fail_htlcs.len(), 1);
3140         assert!(updates.update_fee.is_none());
3141         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3142         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3143         // Drop the last RAA from 3 -> 2
3144
3145         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
3146         expect_pending_htlcs_forwardable!(nodes[2]);
3147         check_added_monitors!(nodes[2], 1);
3148         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3149         assert!(updates.update_add_htlcs.is_empty());
3150         assert!(updates.update_fulfill_htlcs.is_empty());
3151         assert!(updates.update_fail_malformed_htlcs.is_empty());
3152         assert_eq!(updates.update_fail_htlcs.len(), 1);
3153         assert!(updates.update_fee.is_none());
3154         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3155         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3156         check_added_monitors!(nodes[1], 1);
3157         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3158         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3159         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3160         check_added_monitors!(nodes[2], 1);
3161
3162         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
3163         expect_pending_htlcs_forwardable!(nodes[2]);
3164         check_added_monitors!(nodes[2], 1);
3165         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3166         assert!(updates.update_add_htlcs.is_empty());
3167         assert!(updates.update_fulfill_htlcs.is_empty());
3168         assert!(updates.update_fail_malformed_htlcs.is_empty());
3169         assert_eq!(updates.update_fail_htlcs.len(), 1);
3170         assert!(updates.update_fee.is_none());
3171         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3172         // At this point first_payment_hash has dropped out of the latest two commitment
3173         // transactions that nodes[1] is tracking...
3174         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3175         check_added_monitors!(nodes[1], 1);
3176         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3177         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3178         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3179         check_added_monitors!(nodes[2], 1);
3180
3181         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3182         // on nodes[2]'s RAA.
3183         let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3184         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3185         let logger = test_utils::TestLogger::new();
3186         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();
3187         nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
3188         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3189         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3190         check_added_monitors!(nodes[1], 0);
3191
3192         if deliver_bs_raa {
3193                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3194                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3195                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3196                 check_added_monitors!(nodes[1], 1);
3197                 let events = nodes[1].node.get_and_clear_pending_events();
3198                 assert_eq!(events.len(), 1);
3199                 match events[0] {
3200                         Event::PendingHTLCsForwardable { .. } => { },
3201                         _ => panic!("Unexpected event"),
3202                 };
3203                 // Deliberately don't process the pending fail-back so they all fail back at once after
3204                 // block connection just like the !deliver_bs_raa case
3205         }
3206
3207         let mut failed_htlcs = HashSet::new();
3208         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3209
3210         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3211         check_added_monitors!(nodes[1], 1);
3212         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3213
3214         let events = nodes[1].node.get_and_clear_pending_events();
3215         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3216         match events[0] {
3217                 Event::PaymentFailed { ref payment_hash, .. } => {
3218                         assert_eq!(*payment_hash, fourth_payment_hash);
3219                 },
3220                 _ => panic!("Unexpected event"),
3221         }
3222         if !deliver_bs_raa {
3223                 match events[1] {
3224                         Event::PendingHTLCsForwardable { .. } => { },
3225                         _ => panic!("Unexpected event"),
3226                 };
3227         }
3228         nodes[1].node.process_pending_htlc_forwards();
3229         check_added_monitors!(nodes[1], 1);
3230
3231         let events = nodes[1].node.get_and_clear_pending_msg_events();
3232         assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3233         match events[if deliver_bs_raa { 1 } else { 0 }] {
3234                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3235                 _ => panic!("Unexpected event"),
3236         }
3237         match events[if deliver_bs_raa { 2 } else { 1 }] {
3238                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3239                         assert_eq!(channel_id, chan_2.2);
3240                         assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3241                 },
3242                 _ => panic!("Unexpected event"),
3243         }
3244         if deliver_bs_raa {
3245                 match events[0] {
3246                         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, .. } } => {
3247                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3248                                 assert_eq!(update_add_htlcs.len(), 1);
3249                                 assert!(update_fulfill_htlcs.is_empty());
3250                                 assert!(update_fail_htlcs.is_empty());
3251                                 assert!(update_fail_malformed_htlcs.is_empty());
3252                         },
3253                         _ => panic!("Unexpected event"),
3254                 }
3255         }
3256         match events[if deliver_bs_raa { 3 } else { 2 }] {
3257                 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, .. } } => {
3258                         assert!(update_add_htlcs.is_empty());
3259                         assert_eq!(update_fail_htlcs.len(), 3);
3260                         assert!(update_fulfill_htlcs.is_empty());
3261                         assert!(update_fail_malformed_htlcs.is_empty());
3262                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3263
3264                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3265                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3266                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3267
3268                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3269
3270                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3271                         // If we delivered B's RAA we got an unknown preimage error, not something
3272                         // that we should update our routing table for.
3273                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3274                         for event in events {
3275                                 match event {
3276                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3277                                         _ => panic!("Unexpected event"),
3278                                 }
3279                         }
3280                         let events = nodes[0].node.get_and_clear_pending_events();
3281                         assert_eq!(events.len(), 3);
3282                         match events[0] {
3283                                 Event::PaymentFailed { ref payment_hash, .. } => {
3284                                         assert!(failed_htlcs.insert(payment_hash.0));
3285                                 },
3286                                 _ => panic!("Unexpected event"),
3287                         }
3288                         match events[1] {
3289                                 Event::PaymentFailed { ref payment_hash, .. } => {
3290                                         assert!(failed_htlcs.insert(payment_hash.0));
3291                                 },
3292                                 _ => panic!("Unexpected event"),
3293                         }
3294                         match events[2] {
3295                                 Event::PaymentFailed { ref payment_hash, .. } => {
3296                                         assert!(failed_htlcs.insert(payment_hash.0));
3297                                 },
3298                                 _ => panic!("Unexpected event"),
3299                         }
3300                 },
3301                 _ => panic!("Unexpected event"),
3302         }
3303
3304         assert!(failed_htlcs.contains(&first_payment_hash.0));
3305         assert!(failed_htlcs.contains(&second_payment_hash.0));
3306         assert!(failed_htlcs.contains(&third_payment_hash.0));
3307 }
3308
3309 #[test]
3310 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3311         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3312         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3313         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3314         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3315 }
3316
3317 #[test]
3318 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3319         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3320         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3321         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3322         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3323 }
3324
3325 #[test]
3326 fn fail_backward_pending_htlc_upon_channel_failure() {
3327         let chanmon_cfgs = create_chanmon_cfgs(2);
3328         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3329         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3330         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3331         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3332         let logger = test_utils::TestLogger::new();
3333
3334         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3335         {
3336                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3337                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3338                 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();
3339                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3340                 check_added_monitors!(nodes[0], 1);
3341
3342                 let payment_event = {
3343                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3344                         assert_eq!(events.len(), 1);
3345                         SendEvent::from_event(events.remove(0))
3346                 };
3347                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3348                 assert_eq!(payment_event.msgs.len(), 1);
3349         }
3350
3351         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3352         let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3353         {
3354                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3355                 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();
3356                 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3357                 check_added_monitors!(nodes[0], 0);
3358
3359                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3360         }
3361
3362         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3363         {
3364                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3365
3366                 let secp_ctx = Secp256k1::new();
3367                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3368                 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3369                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3370                 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();
3371                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height).unwrap();
3372                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3373                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3374
3375                 // Send a 0-msat update_add_htlc to fail the channel.
3376                 let update_add_htlc = msgs::UpdateAddHTLC {
3377                         channel_id: chan.2,
3378                         htlc_id: 0,
3379                         amount_msat: 0,
3380                         payment_hash,
3381                         cltv_expiry,
3382                         onion_routing_packet,
3383                 };
3384                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3385         }
3386
3387         // Check that Alice fails backward the pending HTLC from the second payment.
3388         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3389         check_closed_broadcast!(nodes[0], true);
3390         check_added_monitors!(nodes[0], 1);
3391 }
3392
3393 #[test]
3394 fn test_htlc_ignore_latest_remote_commitment() {
3395         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3396         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3397         let chanmon_cfgs = create_chanmon_cfgs(2);
3398         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3399         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3400         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3401         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3402
3403         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3404         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3405         check_closed_broadcast!(nodes[0], true);
3406         check_added_monitors!(nodes[0], 1);
3407
3408         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3409         assert_eq!(node_txn.len(), 2);
3410
3411         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3412         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3413         check_closed_broadcast!(nodes[1], true);
3414         check_added_monitors!(nodes[1], 1);
3415
3416         // Duplicate the connect_block call since this may happen due to other listeners
3417         // registering new transactions
3418         header.prev_blockhash = header.block_hash();
3419         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3420 }
3421
3422 #[test]
3423 fn test_force_close_fail_back() {
3424         // Check which HTLCs are failed-backwards on channel force-closure
3425         let chanmon_cfgs = create_chanmon_cfgs(3);
3426         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3427         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3428         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3429         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3430         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3431         let logger = test_utils::TestLogger::new();
3432
3433         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3434
3435         let mut payment_event = {
3436                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3437                 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();
3438                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3439                 check_added_monitors!(nodes[0], 1);
3440
3441                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3442                 assert_eq!(events.len(), 1);
3443                 SendEvent::from_event(events.remove(0))
3444         };
3445
3446         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3447         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3448
3449         expect_pending_htlcs_forwardable!(nodes[1]);
3450
3451         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3452         assert_eq!(events_2.len(), 1);
3453         payment_event = SendEvent::from_event(events_2.remove(0));
3454         assert_eq!(payment_event.msgs.len(), 1);
3455
3456         check_added_monitors!(nodes[1], 1);
3457         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3458         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3459         check_added_monitors!(nodes[2], 1);
3460         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3461
3462         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3463         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3464         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3465
3466         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3467         check_closed_broadcast!(nodes[2], true);
3468         check_added_monitors!(nodes[2], 1);
3469         let tx = {
3470                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3471                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3472                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3473                 // back to nodes[1] upon timeout otherwise.
3474                 assert_eq!(node_txn.len(), 1);
3475                 node_txn.remove(0)
3476         };
3477
3478         mine_transaction(&nodes[1], &tx);
3479
3480         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3481         check_closed_broadcast!(nodes[1], true);
3482         check_added_monitors!(nodes[1], 1);
3483
3484         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3485         {
3486                 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3487                 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3488                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3489         }
3490         mine_transaction(&nodes[2], &tx);
3491         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3492         assert_eq!(node_txn.len(), 1);
3493         assert_eq!(node_txn[0].input.len(), 1);
3494         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3495         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3496         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3497
3498         check_spends!(node_txn[0], tx);
3499 }
3500
3501 #[test]
3502 fn test_dup_events_on_peer_disconnect() {
3503         // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3504         // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3505         // as we used to generate the event immediately upon receipt of the payment preimage in the
3506         // update_fulfill_htlc message.
3507
3508         let chanmon_cfgs = create_chanmon_cfgs(2);
3509         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3510         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3511         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3512         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3513
3514         let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3515
3516         assert!(nodes[1].node.claim_funds(payment_preimage));
3517         check_added_monitors!(nodes[1], 1);
3518         let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3519         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3520         expect_payment_sent!(nodes[0], payment_preimage);
3521
3522         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3523         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3524
3525         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3526         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3527 }
3528
3529 #[test]
3530 fn test_simple_peer_disconnect() {
3531         // Test that we can reconnect when there are no lost messages
3532         let chanmon_cfgs = create_chanmon_cfgs(3);
3533         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3534         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3535         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3536         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3537         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3538
3539         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3540         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3541         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3542
3543         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3544         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3545         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3546         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3547
3548         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3549         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3550         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3551
3552         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3553         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3554         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3555         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3556
3557         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3558         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3559
3560         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3561         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3562
3563         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3564         {
3565                 let events = nodes[0].node.get_and_clear_pending_events();
3566                 assert_eq!(events.len(), 2);
3567                 match events[0] {
3568                         Event::PaymentSent { payment_preimage } => {
3569                                 assert_eq!(payment_preimage, payment_preimage_3);
3570                         },
3571                         _ => panic!("Unexpected event"),
3572                 }
3573                 match events[1] {
3574                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3575                                 assert_eq!(payment_hash, payment_hash_5);
3576                                 assert!(rejected_by_dest);
3577                         },
3578                         _ => panic!("Unexpected event"),
3579                 }
3580         }
3581
3582         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3583         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3584 }
3585
3586 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3587         // Test that we can reconnect when in-flight HTLC updates get dropped
3588         let chanmon_cfgs = create_chanmon_cfgs(2);
3589         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3590         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3591         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3592         if messages_delivered == 0 {
3593                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3594                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3595         } else {
3596                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3597         }
3598
3599         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3600
3601         let logger = test_utils::TestLogger::new();
3602         let payment_event = {
3603                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3604                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3605                         &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3606                         &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3607                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3608                 check_added_monitors!(nodes[0], 1);
3609
3610                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3611                 assert_eq!(events.len(), 1);
3612                 SendEvent::from_event(events.remove(0))
3613         };
3614         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3615
3616         if messages_delivered < 2 {
3617                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3618         } else {
3619                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3620                 if messages_delivered >= 3 {
3621                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3622                         check_added_monitors!(nodes[1], 1);
3623                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3624
3625                         if messages_delivered >= 4 {
3626                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3627                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3628                                 check_added_monitors!(nodes[0], 1);
3629
3630                                 if messages_delivered >= 5 {
3631                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3632                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3633                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3634                                         check_added_monitors!(nodes[0], 1);
3635
3636                                         if messages_delivered >= 6 {
3637                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3638                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3639                                                 check_added_monitors!(nodes[1], 1);
3640                                         }
3641                                 }
3642                         }
3643                 }
3644         }
3645
3646         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3647         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3648         if messages_delivered < 3 {
3649                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3650                 // received on either side, both sides will need to resend them.
3651                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3652         } else if messages_delivered == 3 {
3653                 // nodes[0] still wants its RAA + commitment_signed
3654                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3655         } else if messages_delivered == 4 {
3656                 // nodes[0] still wants its commitment_signed
3657                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3658         } else if messages_delivered == 5 {
3659                 // nodes[1] still wants its final RAA
3660                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3661         } else if messages_delivered == 6 {
3662                 // Everything was delivered...
3663                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3664         }
3665
3666         let events_1 = nodes[1].node.get_and_clear_pending_events();
3667         assert_eq!(events_1.len(), 1);
3668         match events_1[0] {
3669                 Event::PendingHTLCsForwardable { .. } => { },
3670                 _ => panic!("Unexpected event"),
3671         };
3672
3673         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3674         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3675         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3676
3677         nodes[1].node.process_pending_htlc_forwards();
3678
3679         let events_2 = nodes[1].node.get_and_clear_pending_events();
3680         assert_eq!(events_2.len(), 1);
3681         match events_2[0] {
3682                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
3683                         assert_eq!(payment_hash_1, *payment_hash);
3684                         assert!(payment_preimage.is_none());
3685                         assert_eq!(payment_secret_1, *payment_secret);
3686                         assert_eq!(amt, 1000000);
3687                 },
3688                 _ => panic!("Unexpected event"),
3689         }
3690
3691         nodes[1].node.claim_funds(payment_preimage_1);
3692         check_added_monitors!(nodes[1], 1);
3693
3694         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3695         assert_eq!(events_3.len(), 1);
3696         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3697                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3698                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3699                         assert!(updates.update_add_htlcs.is_empty());
3700                         assert!(updates.update_fail_htlcs.is_empty());
3701                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3702                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3703                         assert!(updates.update_fee.is_none());
3704                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3705                 },
3706                 _ => panic!("Unexpected event"),
3707         };
3708
3709         if messages_delivered >= 1 {
3710                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3711
3712                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3713                 assert_eq!(events_4.len(), 1);
3714                 match events_4[0] {
3715                         Event::PaymentSent { ref payment_preimage } => {
3716                                 assert_eq!(payment_preimage_1, *payment_preimage);
3717                         },
3718                         _ => panic!("Unexpected event"),
3719                 }
3720
3721                 if messages_delivered >= 2 {
3722                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3723                         check_added_monitors!(nodes[0], 1);
3724                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3725
3726                         if messages_delivered >= 3 {
3727                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3728                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3729                                 check_added_monitors!(nodes[1], 1);
3730
3731                                 if messages_delivered >= 4 {
3732                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3733                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3734                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3735                                         check_added_monitors!(nodes[1], 1);
3736
3737                                         if messages_delivered >= 5 {
3738                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3739                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3740                                                 check_added_monitors!(nodes[0], 1);
3741                                         }
3742                                 }
3743                         }
3744                 }
3745         }
3746
3747         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3748         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3749         if messages_delivered < 2 {
3750                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3751                 if messages_delivered < 1 {
3752                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3753                         assert_eq!(events_4.len(), 1);
3754                         match events_4[0] {
3755                                 Event::PaymentSent { ref payment_preimage } => {
3756                                         assert_eq!(payment_preimage_1, *payment_preimage);
3757                                 },
3758                                 _ => panic!("Unexpected event"),
3759                         }
3760                 } else {
3761                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3762                 }
3763         } else if messages_delivered == 2 {
3764                 // nodes[0] still wants its RAA + commitment_signed
3765                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3766         } else if messages_delivered == 3 {
3767                 // nodes[0] still wants its commitment_signed
3768                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3769         } else if messages_delivered == 4 {
3770                 // nodes[1] still wants its final RAA
3771                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3772         } else if messages_delivered == 5 {
3773                 // Everything was delivered...
3774                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3775         }
3776
3777         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3778         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3779         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3780
3781         // Channel should still work fine...
3782         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3783         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3784                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3785                 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3786         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3787         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3788 }
3789
3790 #[test]
3791 fn test_drop_messages_peer_disconnect_a() {
3792         do_test_drop_messages_peer_disconnect(0);
3793         do_test_drop_messages_peer_disconnect(1);
3794         do_test_drop_messages_peer_disconnect(2);
3795         do_test_drop_messages_peer_disconnect(3);
3796 }
3797
3798 #[test]
3799 fn test_drop_messages_peer_disconnect_b() {
3800         do_test_drop_messages_peer_disconnect(4);
3801         do_test_drop_messages_peer_disconnect(5);
3802         do_test_drop_messages_peer_disconnect(6);
3803 }
3804
3805 #[test]
3806 fn test_funding_peer_disconnect() {
3807         // Test that we can lock in our funding tx while disconnected
3808         let chanmon_cfgs = create_chanmon_cfgs(2);
3809         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3810         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3811         let persister: test_utils::TestPersister;
3812         let new_chain_monitor: test_utils::TestChainMonitor;
3813         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3814         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3815         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3816
3817         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3818         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3819
3820         confirm_transaction(&nodes[0], &tx);
3821         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3822         assert_eq!(events_1.len(), 1);
3823         match events_1[0] {
3824                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3825                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3826                 },
3827                 _ => panic!("Unexpected event"),
3828         }
3829
3830         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3831
3832         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3833         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3834
3835         confirm_transaction(&nodes[1], &tx);
3836         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3837         assert_eq!(events_2.len(), 2);
3838         let funding_locked = match events_2[0] {
3839                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3840                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3841                         msg.clone()
3842                 },
3843                 _ => panic!("Unexpected event"),
3844         };
3845         let bs_announcement_sigs = match events_2[1] {
3846                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3847                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3848                         msg.clone()
3849                 },
3850                 _ => panic!("Unexpected event"),
3851         };
3852
3853         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3854
3855         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3856         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3857         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3858         assert_eq!(events_3.len(), 2);
3859         let as_announcement_sigs = match events_3[0] {
3860                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3861                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3862                         msg.clone()
3863                 },
3864                 _ => panic!("Unexpected event"),
3865         };
3866         let (as_announcement, as_update) = match events_3[1] {
3867                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3868                         (msg.clone(), update_msg.clone())
3869                 },
3870                 _ => panic!("Unexpected event"),
3871         };
3872
3873         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3874         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3875         assert_eq!(events_4.len(), 1);
3876         let (_, bs_update) = match events_4[0] {
3877                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3878                         (msg.clone(), update_msg.clone())
3879                 },
3880                 _ => panic!("Unexpected event"),
3881         };
3882
3883         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3884         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3885         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3886
3887         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3888         let logger = test_utils::TestLogger::new();
3889         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();
3890         let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3891         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3892
3893         // Check that after deserialization and reconnection we can still generate an identical
3894         // channel_announcement from the cached signatures.
3895         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3896
3897         let nodes_0_serialized = nodes[0].node.encode();
3898         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3899         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3900
3901         persister = test_utils::TestPersister::new();
3902         let keys_manager = &chanmon_cfgs[0].keys_manager;
3903         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);
3904         nodes[0].chain_monitor = &new_chain_monitor;
3905         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3906         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3907                 &mut chan_0_monitor_read, keys_manager).unwrap();
3908         assert!(chan_0_monitor_read.is_empty());
3909
3910         let mut nodes_0_read = &nodes_0_serialized[..];
3911         let (_, nodes_0_deserialized_tmp) = {
3912                 let mut channel_monitors = HashMap::new();
3913                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3914                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3915                         default_config: UserConfig::default(),
3916                         keys_manager,
3917                         fee_estimator: node_cfgs[0].fee_estimator,
3918                         chain_monitor: nodes[0].chain_monitor,
3919                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3920                         logger: nodes[0].logger,
3921                         channel_monitors,
3922                 }).unwrap()
3923         };
3924         nodes_0_deserialized = nodes_0_deserialized_tmp;
3925         assert!(nodes_0_read.is_empty());
3926
3927         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
3928         nodes[0].node = &nodes_0_deserialized;
3929         check_added_monitors!(nodes[0], 1);
3930
3931         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3932
3933         // as_announcement should be re-generated exactly by broadcast_node_announcement.
3934         nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
3935         let msgs = nodes[0].node.get_and_clear_pending_msg_events();
3936         let mut found_announcement = false;
3937         for event in msgs.iter() {
3938                 match event {
3939                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
3940                                 if *msg == as_announcement { found_announcement = true; }
3941                         },
3942                         MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
3943                         _ => panic!("Unexpected event"),
3944                 }
3945         }
3946         assert!(found_announcement);
3947 }
3948
3949 #[test]
3950 fn test_drop_messages_peer_disconnect_dual_htlc() {
3951         // Test that we can handle reconnecting when both sides of a channel have pending
3952         // commitment_updates when we disconnect.
3953         let chanmon_cfgs = create_chanmon_cfgs(2);
3954         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3955         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3956         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3957         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3958         let logger = test_utils::TestLogger::new();
3959
3960         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3961
3962         // Now try to send a second payment which will fail to send
3963         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
3964         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3965         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();
3966         nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
3967         check_added_monitors!(nodes[0], 1);
3968
3969         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3970         assert_eq!(events_1.len(), 1);
3971         match events_1[0] {
3972                 MessageSendEvent::UpdateHTLCs { .. } => {},
3973                 _ => panic!("Unexpected event"),
3974         }
3975
3976         assert!(nodes[1].node.claim_funds(payment_preimage_1));
3977         check_added_monitors!(nodes[1], 1);
3978
3979         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3980         assert_eq!(events_2.len(), 1);
3981         match events_2[0] {
3982                 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 } } => {
3983                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3984                         assert!(update_add_htlcs.is_empty());
3985                         assert_eq!(update_fulfill_htlcs.len(), 1);
3986                         assert!(update_fail_htlcs.is_empty());
3987                         assert!(update_fail_malformed_htlcs.is_empty());
3988                         assert!(update_fee.is_none());
3989
3990                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3991                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3992                         assert_eq!(events_3.len(), 1);
3993                         match events_3[0] {
3994                                 Event::PaymentSent { ref payment_preimage } => {
3995                                         assert_eq!(*payment_preimage, payment_preimage_1);
3996                                 },
3997                                 _ => panic!("Unexpected event"),
3998                         }
3999
4000                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
4001                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4002                         // No commitment_signed so get_event_msg's assert(len == 1) passes
4003                         check_added_monitors!(nodes[0], 1);
4004                 },
4005                 _ => panic!("Unexpected event"),
4006         }
4007
4008         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4009         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4010
4011         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4012         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4013         assert_eq!(reestablish_1.len(), 1);
4014         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4015         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4016         assert_eq!(reestablish_2.len(), 1);
4017
4018         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4019         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4020         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4021         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4022
4023         assert!(as_resp.0.is_none());
4024         assert!(bs_resp.0.is_none());
4025
4026         assert!(bs_resp.1.is_none());
4027         assert!(bs_resp.2.is_none());
4028
4029         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4030
4031         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
4032         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
4033         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4034         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4035         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
4036         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
4037         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
4038         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4039         // No commitment_signed so get_event_msg's assert(len == 1) passes
4040         check_added_monitors!(nodes[1], 1);
4041
4042         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
4043         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4044         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4045         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4046         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4047         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4048         assert!(bs_second_commitment_signed.update_fee.is_none());
4049         check_added_monitors!(nodes[1], 1);
4050
4051         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4052         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4053         assert!(as_commitment_signed.update_add_htlcs.is_empty());
4054         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4055         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4056         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4057         assert!(as_commitment_signed.update_fee.is_none());
4058         check_added_monitors!(nodes[0], 1);
4059
4060         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4061         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4062         // No commitment_signed so get_event_msg's assert(len == 1) passes
4063         check_added_monitors!(nodes[0], 1);
4064
4065         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4066         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4067         // No commitment_signed so get_event_msg's assert(len == 1) passes
4068         check_added_monitors!(nodes[1], 1);
4069
4070         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4071         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4072         check_added_monitors!(nodes[1], 1);
4073
4074         expect_pending_htlcs_forwardable!(nodes[1]);
4075
4076         let events_5 = nodes[1].node.get_and_clear_pending_events();
4077         assert_eq!(events_5.len(), 1);
4078         match events_5[0] {
4079                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt: _, user_payment_id: _ } => {
4080                         assert_eq!(payment_hash_2, *payment_hash);
4081                         assert!(payment_preimage.is_none());
4082                         assert_eq!(payment_secret_2, *payment_secret);
4083                 },
4084                 _ => panic!("Unexpected event"),
4085         }
4086
4087         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4088         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4089         check_added_monitors!(nodes[0], 1);
4090
4091         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4092 }
4093
4094 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4095         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4096         // to avoid our counterparty failing the channel.
4097         let chanmon_cfgs = create_chanmon_cfgs(2);
4098         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4099         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4100         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4101
4102         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4103         let logger = test_utils::TestLogger::new();
4104
4105         let our_payment_hash = if send_partial_mpp {
4106                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4107                 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();
4108                 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
4109                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4110                 // indicates there are more HTLCs coming.
4111                 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.
4112                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height).unwrap();
4113                 check_added_monitors!(nodes[0], 1);
4114                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4115                 assert_eq!(events.len(), 1);
4116                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4117                 // hop should *not* yet generate any PaymentReceived event(s).
4118                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, payment_secret, events.drain(..).next().unwrap(), false);
4119                 our_payment_hash
4120         } else {
4121                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4122         };
4123
4124         let mut block = Block {
4125                 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4126                 txdata: vec![],
4127         };
4128         connect_block(&nodes[0], &block);
4129         connect_block(&nodes[1], &block);
4130         let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
4131         for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
4132                 block.header.prev_blockhash = block.block_hash();
4133                 connect_block(&nodes[0], &block);
4134                 connect_block(&nodes[1], &block);
4135         }
4136
4137         expect_pending_htlcs_forwardable!(nodes[1]);
4138
4139         check_added_monitors!(nodes[1], 1);
4140         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4141         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4142         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4143         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4144         assert!(htlc_timeout_updates.update_fee.is_none());
4145
4146         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4147         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4148         // 100_000 msat as u64, followed by the height at which we failed back above
4149         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4150         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4151         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4152 }
4153
4154 #[test]
4155 fn test_htlc_timeout() {
4156         do_test_htlc_timeout(true);
4157         do_test_htlc_timeout(false);
4158 }
4159
4160 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4161         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4162         let chanmon_cfgs = create_chanmon_cfgs(3);
4163         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4164         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4165         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4166         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4167         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4168
4169         // Make sure all nodes are at the same starting height
4170         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4171         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4172         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4173
4174         let logger = test_utils::TestLogger::new();
4175
4176         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4177         let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4178         {
4179                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4180                 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();
4181                 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4182         }
4183         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4184         check_added_monitors!(nodes[1], 1);
4185
4186         // Now attempt to route a second payment, which should be placed in the holding cell
4187         let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4188         if forwarded_htlc {
4189                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4190                 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();
4191                 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4192                 check_added_monitors!(nodes[0], 1);
4193                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4194                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4195                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4196                 expect_pending_htlcs_forwardable!(nodes[1]);
4197                 check_added_monitors!(nodes[1], 0);
4198         } else {
4199                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4200                 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();
4201                 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4202                 check_added_monitors!(nodes[1], 0);
4203         }
4204
4205         connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4206         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4207         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4208         connect_blocks(&nodes[1], 1);
4209
4210         if forwarded_htlc {
4211                 expect_pending_htlcs_forwardable!(nodes[1]);
4212                 check_added_monitors!(nodes[1], 1);
4213                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4214                 assert_eq!(fail_commit.len(), 1);
4215                 match fail_commit[0] {
4216                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4217                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4218                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4219                         },
4220                         _ => unreachable!(),
4221                 }
4222                 expect_payment_failed!(nodes[0], second_payment_hash, false);
4223                 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4224                         match update {
4225                                 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4226                                 _ => panic!("Unexpected event"),
4227                         }
4228                 } else {
4229                         panic!("Unexpected event");
4230                 }
4231         } else {
4232                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4233         }
4234 }
4235
4236 #[test]
4237 fn test_holding_cell_htlc_add_timeouts() {
4238         do_test_holding_cell_htlc_add_timeouts(false);
4239         do_test_holding_cell_htlc_add_timeouts(true);
4240 }
4241
4242 #[test]
4243 fn test_invalid_channel_announcement() {
4244         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4245         let secp_ctx = Secp256k1::new();
4246         let chanmon_cfgs = create_chanmon_cfgs(2);
4247         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4248         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4249         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4250
4251         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4252
4253         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4254         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4255         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4256         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4257
4258         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 } );
4259
4260         let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4261         let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4262
4263         let as_network_key = nodes[0].node.get_our_node_id();
4264         let bs_network_key = nodes[1].node.get_our_node_id();
4265
4266         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4267
4268         let mut chan_announcement;
4269
4270         macro_rules! dummy_unsigned_msg {
4271                 () => {
4272                         msgs::UnsignedChannelAnnouncement {
4273                                 features: ChannelFeatures::known(),
4274                                 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4275                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4276                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4277                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4278                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4279                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4280                                 excess_data: Vec::new(),
4281                         };
4282                 }
4283         }
4284
4285         macro_rules! sign_msg {
4286                 ($unsigned_msg: expr) => {
4287                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4288                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4289                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4290                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4291                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4292                         chan_announcement = msgs::ChannelAnnouncement {
4293                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4294                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4295                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4296                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4297                                 contents: $unsigned_msg
4298                         }
4299                 }
4300         }
4301
4302         let unsigned_msg = dummy_unsigned_msg!();
4303         sign_msg!(unsigned_msg);
4304         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4305         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 } );
4306
4307         // Configured with Network::Testnet
4308         let mut unsigned_msg = dummy_unsigned_msg!();
4309         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4310         sign_msg!(unsigned_msg);
4311         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4312
4313         let mut unsigned_msg = dummy_unsigned_msg!();
4314         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4315         sign_msg!(unsigned_msg);
4316         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4317 }
4318
4319 #[test]
4320 fn test_no_txn_manager_serialize_deserialize() {
4321         let chanmon_cfgs = create_chanmon_cfgs(2);
4322         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4323         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4324         let logger: test_utils::TestLogger;
4325         let fee_estimator: test_utils::TestFeeEstimator;
4326         let persister: test_utils::TestPersister;
4327         let new_chain_monitor: test_utils::TestChainMonitor;
4328         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4329         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4330
4331         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4332
4333         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4334
4335         let nodes_0_serialized = nodes[0].node.encode();
4336         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4337         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4338
4339         logger = test_utils::TestLogger::new();
4340         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4341         persister = test_utils::TestPersister::new();
4342         let keys_manager = &chanmon_cfgs[0].keys_manager;
4343         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4344         nodes[0].chain_monitor = &new_chain_monitor;
4345         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4346         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4347                 &mut chan_0_monitor_read, keys_manager).unwrap();
4348         assert!(chan_0_monitor_read.is_empty());
4349
4350         let mut nodes_0_read = &nodes_0_serialized[..];
4351         let config = UserConfig::default();
4352         let (_, nodes_0_deserialized_tmp) = {
4353                 let mut channel_monitors = HashMap::new();
4354                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4355                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4356                         default_config: config,
4357                         keys_manager,
4358                         fee_estimator: &fee_estimator,
4359                         chain_monitor: nodes[0].chain_monitor,
4360                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4361                         logger: &logger,
4362                         channel_monitors,
4363                 }).unwrap()
4364         };
4365         nodes_0_deserialized = nodes_0_deserialized_tmp;
4366         assert!(nodes_0_read.is_empty());
4367
4368         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4369         nodes[0].node = &nodes_0_deserialized;
4370         assert_eq!(nodes[0].node.list_channels().len(), 1);
4371         check_added_monitors!(nodes[0], 1);
4372
4373         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4374         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4375         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4376         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4377
4378         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4379         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4380         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4381         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4382
4383         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4384         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4385         for node in nodes.iter() {
4386                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4387                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4388                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4389         }
4390
4391         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4392 }
4393
4394 #[test]
4395 fn test_dup_htlc_onchain_fails_on_reload() {
4396         // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4397         // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4398         // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4399         // the ChannelMonitor tells it to.
4400         //
4401         // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4402         // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4403         // PaymentFailed event appearing). However, because we may not serialize the relevant
4404         // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4405         // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4406         // and de-duplicates ChannelMonitor events.
4407         //
4408         // This tests that explicit tracking behavior.
4409         let chanmon_cfgs = create_chanmon_cfgs(2);
4410         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4411         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4412         let persister: test_utils::TestPersister;
4413         let new_chain_monitor: test_utils::TestChainMonitor;
4414         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4415         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4416
4417         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4418
4419         // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4420         // nodes[0].
4421         let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4422         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4423         check_closed_broadcast!(nodes[0], true);
4424         check_added_monitors!(nodes[0], 1);
4425
4426         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4427         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4428
4429         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4430         assert_eq!(node_txn.len(), 2);
4431
4432         assert!(nodes[1].node.claim_funds(payment_preimage));
4433         check_added_monitors!(nodes[1], 1);
4434
4435         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4436         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
4437         check_closed_broadcast!(nodes[1], true);
4438         check_added_monitors!(nodes[1], 1);
4439         let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4440
4441         connect_block(&nodes[0], &Block { header, txdata: node_txn});
4442
4443         // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4444         // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4445         // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4446         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4447         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4448
4449         header.prev_blockhash = header.block_hash();
4450         let claim_block = Block { header, txdata: claim_txn};
4451         connect_block(&nodes[0], &claim_block);
4452         expect_payment_sent!(nodes[0], payment_preimage);
4453
4454         // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4455         // connected a highly-relevant block, it likely gets serialized out now.
4456         let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4457         nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4458
4459         // Now reload nodes[0]...
4460         persister = test_utils::TestPersister::new();
4461         let keys_manager = &chanmon_cfgs[0].keys_manager;
4462         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);
4463         nodes[0].chain_monitor = &new_chain_monitor;
4464         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4465         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4466                 &mut chan_0_monitor_read, keys_manager).unwrap();
4467         assert!(chan_0_monitor_read.is_empty());
4468
4469         let (_, nodes_0_deserialized_tmp) = {
4470                 let mut channel_monitors = HashMap::new();
4471                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4472                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4473                         ::read(&mut std::io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4474                                 default_config: Default::default(),
4475                                 keys_manager,
4476                                 fee_estimator: node_cfgs[0].fee_estimator,
4477                                 chain_monitor: nodes[0].chain_monitor,
4478                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4479                                 logger: nodes[0].logger,
4480                                 channel_monitors,
4481                         }).unwrap()
4482         };
4483         nodes_0_deserialized = nodes_0_deserialized_tmp;
4484
4485         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4486         check_added_monitors!(nodes[0], 1);
4487         nodes[0].node = &nodes_0_deserialized;
4488
4489         // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4490         // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4491         // payment events should kick in, leaving us with no pending events here.
4492         nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, nodes[0].blocks.borrow().len() as u32 - 1);
4493         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4494 }
4495
4496 #[test]
4497 fn test_manager_serialize_deserialize_events() {
4498         // This test makes sure the events field in ChannelManager survives de/serialization
4499         let chanmon_cfgs = create_chanmon_cfgs(2);
4500         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4501         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4502         let fee_estimator: test_utils::TestFeeEstimator;
4503         let persister: test_utils::TestPersister;
4504         let logger: test_utils::TestLogger;
4505         let new_chain_monitor: test_utils::TestChainMonitor;
4506         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4507         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4508
4509         // Start creating a channel, but stop right before broadcasting the funding transaction
4510         let channel_value = 100000;
4511         let push_msat = 10001;
4512         let a_flags = InitFeatures::known();
4513         let b_flags = InitFeatures::known();
4514         let node_a = nodes.remove(0);
4515         let node_b = nodes.remove(0);
4516         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4517         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()));
4518         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()));
4519
4520         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4521
4522         node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4523         check_added_monitors!(node_a, 0);
4524
4525         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()));
4526         {
4527                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4528                 assert_eq!(added_monitors.len(), 1);
4529                 assert_eq!(added_monitors[0].0, funding_output);
4530                 added_monitors.clear();
4531         }
4532
4533         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()));
4534         {
4535                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4536                 assert_eq!(added_monitors.len(), 1);
4537                 assert_eq!(added_monitors[0].0, funding_output);
4538                 added_monitors.clear();
4539         }
4540         // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4541
4542         nodes.push(node_a);
4543         nodes.push(node_b);
4544
4545         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4546         let nodes_0_serialized = nodes[0].node.encode();
4547         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4548         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4549
4550         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4551         logger = test_utils::TestLogger::new();
4552         persister = test_utils::TestPersister::new();
4553         let keys_manager = &chanmon_cfgs[0].keys_manager;
4554         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4555         nodes[0].chain_monitor = &new_chain_monitor;
4556         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4557         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4558                 &mut chan_0_monitor_read, keys_manager).unwrap();
4559         assert!(chan_0_monitor_read.is_empty());
4560
4561         let mut nodes_0_read = &nodes_0_serialized[..];
4562         let config = UserConfig::default();
4563         let (_, nodes_0_deserialized_tmp) = {
4564                 let mut channel_monitors = HashMap::new();
4565                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4566                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4567                         default_config: config,
4568                         keys_manager,
4569                         fee_estimator: &fee_estimator,
4570                         chain_monitor: nodes[0].chain_monitor,
4571                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4572                         logger: &logger,
4573                         channel_monitors,
4574                 }).unwrap()
4575         };
4576         nodes_0_deserialized = nodes_0_deserialized_tmp;
4577         assert!(nodes_0_read.is_empty());
4578
4579         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4580
4581         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4582         nodes[0].node = &nodes_0_deserialized;
4583
4584         // After deserializing, make sure the funding_transaction is still held by the channel manager
4585         let events_4 = nodes[0].node.get_and_clear_pending_events();
4586         assert_eq!(events_4.len(), 0);
4587         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4588         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4589
4590         // Make sure the channel is functioning as though the de/serialization never happened
4591         assert_eq!(nodes[0].node.list_channels().len(), 1);
4592         check_added_monitors!(nodes[0], 1);
4593
4594         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4595         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4596         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4597         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4598
4599         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4600         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4601         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4602         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4603
4604         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4605         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4606         for node in nodes.iter() {
4607                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4608                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4609                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4610         }
4611
4612         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4613 }
4614
4615 #[test]
4616 fn test_simple_manager_serialize_deserialize() {
4617         let chanmon_cfgs = create_chanmon_cfgs(2);
4618         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4619         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4620         let logger: test_utils::TestLogger;
4621         let fee_estimator: test_utils::TestFeeEstimator;
4622         let persister: test_utils::TestPersister;
4623         let new_chain_monitor: test_utils::TestChainMonitor;
4624         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4625         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4626         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4627
4628         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4629         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4630
4631         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4632
4633         let nodes_0_serialized = nodes[0].node.encode();
4634         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4635         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4636
4637         logger = test_utils::TestLogger::new();
4638         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4639         persister = test_utils::TestPersister::new();
4640         let keys_manager = &chanmon_cfgs[0].keys_manager;
4641         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4642         nodes[0].chain_monitor = &new_chain_monitor;
4643         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4644         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4645                 &mut chan_0_monitor_read, keys_manager).unwrap();
4646         assert!(chan_0_monitor_read.is_empty());
4647
4648         let mut nodes_0_read = &nodes_0_serialized[..];
4649         let (_, nodes_0_deserialized_tmp) = {
4650                 let mut channel_monitors = HashMap::new();
4651                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4652                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4653                         default_config: UserConfig::default(),
4654                         keys_manager,
4655                         fee_estimator: &fee_estimator,
4656                         chain_monitor: nodes[0].chain_monitor,
4657                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4658                         logger: &logger,
4659                         channel_monitors,
4660                 }).unwrap()
4661         };
4662         nodes_0_deserialized = nodes_0_deserialized_tmp;
4663         assert!(nodes_0_read.is_empty());
4664
4665         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4666         nodes[0].node = &nodes_0_deserialized;
4667         check_added_monitors!(nodes[0], 1);
4668
4669         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4670
4671         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4672         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4673 }
4674
4675 #[test]
4676 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4677         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4678         let chanmon_cfgs = create_chanmon_cfgs(4);
4679         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4680         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4681         let logger: test_utils::TestLogger;
4682         let fee_estimator: test_utils::TestFeeEstimator;
4683         let persister: test_utils::TestPersister;
4684         let new_chain_monitor: test_utils::TestChainMonitor;
4685         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4686         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4687         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4688         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4689         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4690
4691         let mut node_0_stale_monitors_serialized = Vec::new();
4692         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4693                 let mut writer = test_utils::TestVecWriter(Vec::new());
4694                 monitor.1.write(&mut writer).unwrap();
4695                 node_0_stale_monitors_serialized.push(writer.0);
4696         }
4697
4698         let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4699
4700         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4701         let nodes_0_serialized = nodes[0].node.encode();
4702
4703         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4704         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4705         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4706         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4707
4708         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4709         // nodes[3])
4710         let mut node_0_monitors_serialized = Vec::new();
4711         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4712                 let mut writer = test_utils::TestVecWriter(Vec::new());
4713                 monitor.1.write(&mut writer).unwrap();
4714                 node_0_monitors_serialized.push(writer.0);
4715         }
4716
4717         logger = test_utils::TestLogger::new();
4718         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4719         persister = test_utils::TestPersister::new();
4720         let keys_manager = &chanmon_cfgs[0].keys_manager;
4721         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4722         nodes[0].chain_monitor = &new_chain_monitor;
4723
4724
4725         let mut node_0_stale_monitors = Vec::new();
4726         for serialized in node_0_stale_monitors_serialized.iter() {
4727                 let mut read = &serialized[..];
4728                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4729                 assert!(read.is_empty());
4730                 node_0_stale_monitors.push(monitor);
4731         }
4732
4733         let mut node_0_monitors = Vec::new();
4734         for serialized in node_0_monitors_serialized.iter() {
4735                 let mut read = &serialized[..];
4736                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4737                 assert!(read.is_empty());
4738                 node_0_monitors.push(monitor);
4739         }
4740
4741         let mut nodes_0_read = &nodes_0_serialized[..];
4742         if let Err(msgs::DecodeError::InvalidValue) =
4743                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4744                 default_config: UserConfig::default(),
4745                 keys_manager,
4746                 fee_estimator: &fee_estimator,
4747                 chain_monitor: nodes[0].chain_monitor,
4748                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4749                 logger: &logger,
4750                 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4751         }) { } else {
4752                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4753         };
4754
4755         let mut nodes_0_read = &nodes_0_serialized[..];
4756         let (_, nodes_0_deserialized_tmp) =
4757                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4758                 default_config: UserConfig::default(),
4759                 keys_manager,
4760                 fee_estimator: &fee_estimator,
4761                 chain_monitor: nodes[0].chain_monitor,
4762                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4763                 logger: &logger,
4764                 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4765         }).unwrap();
4766         nodes_0_deserialized = nodes_0_deserialized_tmp;
4767         assert!(nodes_0_read.is_empty());
4768
4769         { // Channel close should result in a commitment tx and an HTLC tx
4770                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4771                 assert_eq!(txn.len(), 2);
4772                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4773                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4774         }
4775
4776         for monitor in node_0_monitors.drain(..) {
4777                 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4778                 check_added_monitors!(nodes[0], 1);
4779         }
4780         nodes[0].node = &nodes_0_deserialized;
4781
4782         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4783         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4784         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4785         //... and we can even still claim the payment!
4786         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4787
4788         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4789         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4790         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4791         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4792         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4793         assert_eq!(msg_events.len(), 1);
4794         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4795                 match action {
4796                         &ErrorAction::SendErrorMessage { ref msg } => {
4797                                 assert_eq!(msg.channel_id, channel_id);
4798                         },
4799                         _ => panic!("Unexpected event!"),
4800                 }
4801         }
4802 }
4803
4804 macro_rules! check_spendable_outputs {
4805         ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4806                 {
4807                         let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4808                         let mut txn = Vec::new();
4809                         let mut all_outputs = Vec::new();
4810                         let secp_ctx = Secp256k1::new();
4811                         for event in events.drain(..) {
4812                                 match event {
4813                                         Event::SpendableOutputs { mut outputs } => {
4814                                                 for outp in outputs.drain(..) {
4815                                                         txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4816                                                         all_outputs.push(outp);
4817                                                 }
4818                                         },
4819                                         _ => panic!("Unexpected event"),
4820                                 };
4821                         }
4822                         if all_outputs.len() > 1 {
4823                                 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) {
4824                                         txn.push(tx);
4825                                 }
4826                         }
4827                         txn
4828                 }
4829         }
4830 }
4831
4832 #[test]
4833 fn test_claim_sizeable_push_msat() {
4834         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4835         let chanmon_cfgs = create_chanmon_cfgs(2);
4836         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4837         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4838         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4839
4840         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4841         nodes[1].node.force_close_channel(&chan.2).unwrap();
4842         check_closed_broadcast!(nodes[1], true);
4843         check_added_monitors!(nodes[1], 1);
4844         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4845         assert_eq!(node_txn.len(), 1);
4846         check_spends!(node_txn[0], chan.3);
4847         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
4848
4849         mine_transaction(&nodes[1], &node_txn[0]);
4850         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4851
4852         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4853         assert_eq!(spend_txn.len(), 1);
4854         check_spends!(spend_txn[0], node_txn[0]);
4855 }
4856
4857 #[test]
4858 fn test_claim_on_remote_sizeable_push_msat() {
4859         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4860         // to_remote output is encumbered by a P2WPKH
4861         let chanmon_cfgs = create_chanmon_cfgs(2);
4862         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4863         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4864         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4865
4866         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4867         nodes[0].node.force_close_channel(&chan.2).unwrap();
4868         check_closed_broadcast!(nodes[0], true);
4869         check_added_monitors!(nodes[0], 1);
4870
4871         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4872         assert_eq!(node_txn.len(), 1);
4873         check_spends!(node_txn[0], chan.3);
4874         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
4875
4876         mine_transaction(&nodes[1], &node_txn[0]);
4877         check_closed_broadcast!(nodes[1], true);
4878         check_added_monitors!(nodes[1], 1);
4879         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4880
4881         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4882         assert_eq!(spend_txn.len(), 1);
4883         check_spends!(spend_txn[0], node_txn[0]);
4884 }
4885
4886 #[test]
4887 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4888         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4889         // to_remote output is encumbered by a P2WPKH
4890
4891         let chanmon_cfgs = create_chanmon_cfgs(2);
4892         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4893         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4894         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4895
4896         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4897         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4898         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4899         assert_eq!(revoked_local_txn[0].input.len(), 1);
4900         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4901
4902         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4903         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4904         check_closed_broadcast!(nodes[1], true);
4905         check_added_monitors!(nodes[1], 1);
4906
4907         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4908         mine_transaction(&nodes[1], &node_txn[0]);
4909         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4910
4911         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4912         assert_eq!(spend_txn.len(), 3);
4913         check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4914         check_spends!(spend_txn[1], node_txn[0]);
4915         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4916 }
4917
4918 #[test]
4919 fn test_static_spendable_outputs_preimage_tx() {
4920         let chanmon_cfgs = create_chanmon_cfgs(2);
4921         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4922         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4923         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4924
4925         // Create some initial channels
4926         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4927
4928         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4929
4930         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4931         assert_eq!(commitment_tx[0].input.len(), 1);
4932         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4933
4934         // Settle A's commitment tx on B's chain
4935         assert!(nodes[1].node.claim_funds(payment_preimage));
4936         check_added_monitors!(nodes[1], 1);
4937         mine_transaction(&nodes[1], &commitment_tx[0]);
4938         check_added_monitors!(nodes[1], 1);
4939         let events = nodes[1].node.get_and_clear_pending_msg_events();
4940         match events[0] {
4941                 MessageSendEvent::UpdateHTLCs { .. } => {},
4942                 _ => panic!("Unexpected event"),
4943         }
4944         match events[1] {
4945                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4946                 _ => panic!("Unexepected event"),
4947         }
4948
4949         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4950         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4951         assert_eq!(node_txn.len(), 3);
4952         check_spends!(node_txn[0], commitment_tx[0]);
4953         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4954         check_spends!(node_txn[1], chan_1.3);
4955         check_spends!(node_txn[2], node_txn[1]);
4956
4957         mine_transaction(&nodes[1], &node_txn[0]);
4958         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4959
4960         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4961         assert_eq!(spend_txn.len(), 1);
4962         check_spends!(spend_txn[0], node_txn[0]);
4963 }
4964
4965 #[test]
4966 fn test_static_spendable_outputs_timeout_tx() {
4967         let chanmon_cfgs = create_chanmon_cfgs(2);
4968         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4969         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4970         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4971
4972         // Create some initial channels
4973         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4974
4975         // Rebalance the network a bit by relaying one payment through all the channels ...
4976         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4977
4978         let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4979
4980         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4981         assert_eq!(commitment_tx[0].input.len(), 1);
4982         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4983
4984         // Settle A's commitment tx on B' chain
4985         mine_transaction(&nodes[1], &commitment_tx[0]);
4986         check_added_monitors!(nodes[1], 1);
4987         let events = nodes[1].node.get_and_clear_pending_msg_events();
4988         match events[0] {
4989                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4990                 _ => panic!("Unexpected event"),
4991         }
4992
4993         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4994         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4995         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4996         check_spends!(node_txn[0],  commitment_tx[0].clone());
4997         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4998         check_spends!(node_txn[1], chan_1.3.clone());
4999         check_spends!(node_txn[2], node_txn[1]);
5000
5001         mine_transaction(&nodes[1], &node_txn[0]);
5002         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5003         expect_payment_failed!(nodes[1], our_payment_hash, true);
5004
5005         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5006         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
5007         check_spends!(spend_txn[0], commitment_tx[0]);
5008         check_spends!(spend_txn[1], node_txn[0]);
5009         check_spends!(spend_txn[2], node_txn[0], commitment_tx[0]); // All outputs
5010 }
5011
5012 #[test]
5013 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
5014         let chanmon_cfgs = create_chanmon_cfgs(2);
5015         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5016         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5017         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5018
5019         // Create some initial channels
5020         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5021
5022         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5023         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5024         assert_eq!(revoked_local_txn[0].input.len(), 1);
5025         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5026
5027         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5028
5029         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5030         check_closed_broadcast!(nodes[1], true);
5031         check_added_monitors!(nodes[1], 1);
5032
5033         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5034         assert_eq!(node_txn.len(), 2);
5035         assert_eq!(node_txn[0].input.len(), 2);
5036         check_spends!(node_txn[0], revoked_local_txn[0]);
5037
5038         mine_transaction(&nodes[1], &node_txn[0]);
5039         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5040
5041         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5042         assert_eq!(spend_txn.len(), 1);
5043         check_spends!(spend_txn[0], node_txn[0]);
5044 }
5045
5046 #[test]
5047 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5048         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5049         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
5050         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5051         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5052         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5053
5054         // Create some initial channels
5055         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5056
5057         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5058         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5059         assert_eq!(revoked_local_txn[0].input.len(), 1);
5060         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5061
5062         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5063
5064         // A will generate HTLC-Timeout from revoked commitment tx
5065         mine_transaction(&nodes[0], &revoked_local_txn[0]);
5066         check_closed_broadcast!(nodes[0], true);
5067         check_added_monitors!(nodes[0], 1);
5068
5069         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5070         assert_eq!(revoked_htlc_txn.len(), 2);
5071         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5072         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5073         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5074         check_spends!(revoked_htlc_txn[1], chan_1.3);
5075
5076         // B will generate justice tx from A's revoked commitment/HTLC tx
5077         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5078         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5079         check_closed_broadcast!(nodes[1], true);
5080         check_added_monitors!(nodes[1], 1);
5081
5082         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5083         assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
5084         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5085         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5086         // transactions next...
5087         assert_eq!(node_txn[0].input.len(), 3);
5088         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5089
5090         assert_eq!(node_txn[1].input.len(), 2);
5091         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[0]);
5092         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5093                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5094         } else {
5095                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5096                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5097         }
5098
5099         assert_eq!(node_txn[2].input.len(), 1);
5100         check_spends!(node_txn[2], chan_1.3);
5101
5102         mine_transaction(&nodes[1], &node_txn[1]);
5103         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5104
5105         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5106         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5107         assert_eq!(spend_txn.len(), 1);
5108         assert_eq!(spend_txn[0].input.len(), 1);
5109         check_spends!(spend_txn[0], node_txn[1]);
5110 }
5111
5112 #[test]
5113 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5114         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5115         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
5116         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5117         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5118         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5119
5120         // Create some initial channels
5121         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5122
5123         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5124         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5125         assert_eq!(revoked_local_txn[0].input.len(), 1);
5126         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5127
5128         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5129         assert_eq!(revoked_local_txn[0].output.len(), 2);
5130
5131         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5132
5133         // B will generate HTLC-Success from revoked commitment tx
5134         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5135         check_closed_broadcast!(nodes[1], true);
5136         check_added_monitors!(nodes[1], 1);
5137         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5138
5139         assert_eq!(revoked_htlc_txn.len(), 2);
5140         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5141         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5142         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5143
5144         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5145         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5146         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5147
5148         // A will generate justice tx from B's revoked commitment/HTLC tx
5149         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5150         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5151         check_closed_broadcast!(nodes[0], true);
5152         check_added_monitors!(nodes[0], 1);
5153
5154         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5155         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5156
5157         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5158         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5159         // transactions next...
5160         assert_eq!(node_txn[0].input.len(), 2);
5161         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5162         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5163                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5164         } else {
5165                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5166                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5167         }
5168
5169         assert_eq!(node_txn[1].input.len(), 1);
5170         check_spends!(node_txn[1], revoked_htlc_txn[0]);
5171
5172         check_spends!(node_txn[2], chan_1.3);
5173
5174         mine_transaction(&nodes[0], &node_txn[1]);
5175         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5176
5177         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5178         // didn't try to generate any new transactions.
5179
5180         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5181         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5182         assert_eq!(spend_txn.len(), 3);
5183         assert_eq!(spend_txn[0].input.len(), 1);
5184         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5185         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5186         check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5187         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5188 }
5189
5190 #[test]
5191 fn test_onchain_to_onchain_claim() {
5192         // Test that in case of channel closure, we detect the state of output and claim HTLC
5193         // on downstream peer's remote commitment tx.
5194         // First, have C claim an HTLC against its own latest commitment transaction.
5195         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5196         // channel.
5197         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5198         // gets broadcast.
5199
5200         let chanmon_cfgs = create_chanmon_cfgs(3);
5201         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5202         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5203         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5204
5205         // Create some initial channels
5206         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5207         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5208
5209         // Rebalance the network a bit by relaying one payment through all the channels ...
5210         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5211         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5212
5213         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5214         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5215         check_spends!(commitment_tx[0], chan_2.3);
5216         nodes[2].node.claim_funds(payment_preimage);
5217         check_added_monitors!(nodes[2], 1);
5218         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5219         assert!(updates.update_add_htlcs.is_empty());
5220         assert!(updates.update_fail_htlcs.is_empty());
5221         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5222         assert!(updates.update_fail_malformed_htlcs.is_empty());
5223
5224         mine_transaction(&nodes[2], &commitment_tx[0]);
5225         check_closed_broadcast!(nodes[2], true);
5226         check_added_monitors!(nodes[2], 1);
5227
5228         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5229         assert_eq!(c_txn.len(), 3);
5230         assert_eq!(c_txn[0], c_txn[2]);
5231         assert_eq!(commitment_tx[0], c_txn[1]);
5232         check_spends!(c_txn[1], chan_2.3);
5233         check_spends!(c_txn[2], c_txn[1]);
5234         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5235         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5236         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5237         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5238
5239         // 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
5240         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5241         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5242         {
5243                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5244                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
5245                 assert_eq!(b_txn.len(), 3);
5246                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
5247                 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5248                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5249                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5250                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5251                 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5252                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5253                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5254                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5255                 b_txn.clear();
5256         }
5257         check_added_monitors!(nodes[1], 1);
5258         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5259         assert_eq!(msg_events.len(), 3);
5260         check_added_monitors!(nodes[1], 1);
5261         match msg_events[0] {
5262                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5263                 _ => panic!("Unexpected event"),
5264         }
5265         match msg_events[1] {
5266                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5267                 _ => panic!("Unexpected event"),
5268         }
5269         match msg_events[2] {
5270                 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, .. } } => {
5271                         assert!(update_add_htlcs.is_empty());
5272                         assert!(update_fail_htlcs.is_empty());
5273                         assert_eq!(update_fulfill_htlcs.len(), 1);
5274                         assert!(update_fail_malformed_htlcs.is_empty());
5275                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5276                 },
5277                 _ => panic!("Unexpected event"),
5278         };
5279         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5280         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5281         mine_transaction(&nodes[1], &commitment_tx[0]);
5282         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5283         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5284         assert_eq!(b_txn.len(), 3);
5285         check_spends!(b_txn[1], chan_1.3);
5286         check_spends!(b_txn[2], b_txn[1]);
5287         check_spends!(b_txn[0], commitment_tx[0]);
5288         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5289         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5290         assert_eq!(b_txn[0].lock_time, 0); // Success tx
5291
5292         check_closed_broadcast!(nodes[1], true);
5293         check_added_monitors!(nodes[1], 1);
5294 }
5295
5296 #[test]
5297 fn test_duplicate_payment_hash_one_failure_one_success() {
5298         // Topology : A --> B --> C --> D
5299         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5300         // Note that because C will refuse to generate two payment secrets for the same payment hash,
5301         // we forward one of the payments onwards to D.
5302         let chanmon_cfgs = create_chanmon_cfgs(4);
5303         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5304         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
5305         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5306
5307         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5308         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5309         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5310
5311         let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5312
5313         let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5314         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
5315                 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
5316         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5317
5318         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5319         assert_eq!(commitment_txn[0].input.len(), 1);
5320         check_spends!(commitment_txn[0], chan_2.3);
5321
5322         mine_transaction(&nodes[1], &commitment_txn[0]);
5323         check_closed_broadcast!(nodes[1], true);
5324         check_added_monitors!(nodes[1], 1);
5325
5326         let htlc_timeout_tx;
5327         { // Extract one of the two HTLC-Timeout transaction
5328                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5329                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
5330                 assert_eq!(node_txn.len(), 5);
5331                 check_spends!(node_txn[0], commitment_txn[0]);
5332                 assert_eq!(node_txn[0].input.len(), 1);
5333                 check_spends!(node_txn[1], commitment_txn[0]);
5334                 assert_eq!(node_txn[1].input.len(), 1);
5335                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5336                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5337                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5338                 check_spends!(node_txn[2], chan_2.3);
5339                 check_spends!(node_txn[3], node_txn[2]);
5340                 check_spends!(node_txn[4], node_txn[2]);
5341                 htlc_timeout_tx = node_txn[1].clone();
5342         }
5343
5344         nodes[2].node.claim_funds(our_payment_preimage);
5345         mine_transaction(&nodes[2], &commitment_txn[0]);
5346         check_added_monitors!(nodes[2], 2);
5347         let events = nodes[2].node.get_and_clear_pending_msg_events();
5348         match events[0] {
5349                 MessageSendEvent::UpdateHTLCs { .. } => {},
5350                 _ => panic!("Unexpected event"),
5351         }
5352         match events[1] {
5353                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5354                 _ => panic!("Unexepected event"),
5355         }
5356         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5357         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)
5358         check_spends!(htlc_success_txn[2], chan_2.3);
5359         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
5360         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
5361         assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5362         assert_eq!(htlc_success_txn[0].input.len(), 1);
5363         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5364         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5365         assert_eq!(htlc_success_txn[1].input.len(), 1);
5366         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5367         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5368         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5369         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5370
5371         mine_transaction(&nodes[1], &htlc_timeout_tx);
5372         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5373         expect_pending_htlcs_forwardable!(nodes[1]);
5374         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5375         assert!(htlc_updates.update_add_htlcs.is_empty());
5376         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5377         let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5378         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5379         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5380         check_added_monitors!(nodes[1], 1);
5381
5382         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5383         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5384         {
5385                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5386                 let events = nodes[0].node.get_and_clear_pending_msg_events();
5387                 assert_eq!(events.len(), 1);
5388                 match events[0] {
5389                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
5390                         },
5391                         _ => { panic!("Unexpected event"); }
5392                 }
5393         }
5394         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5395
5396         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5397         mine_transaction(&nodes[1], &htlc_success_txn[0]);
5398         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5399         assert!(updates.update_add_htlcs.is_empty());
5400         assert!(updates.update_fail_htlcs.is_empty());
5401         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5402         assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5403         assert!(updates.update_fail_malformed_htlcs.is_empty());
5404         check_added_monitors!(nodes[1], 1);
5405
5406         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5407         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5408
5409         let events = nodes[0].node.get_and_clear_pending_events();
5410         match events[0] {
5411                 Event::PaymentSent { ref payment_preimage } => {
5412                         assert_eq!(*payment_preimage, our_payment_preimage);
5413                 }
5414                 _ => panic!("Unexpected event"),
5415         }
5416 }
5417
5418 #[test]
5419 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5420         let chanmon_cfgs = create_chanmon_cfgs(2);
5421         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5422         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5423         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5424
5425         // Create some initial channels
5426         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5427
5428         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5429         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5430         assert_eq!(local_txn.len(), 1);
5431         assert_eq!(local_txn[0].input.len(), 1);
5432         check_spends!(local_txn[0], chan_1.3);
5433
5434         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5435         nodes[1].node.claim_funds(payment_preimage);
5436         check_added_monitors!(nodes[1], 1);
5437         mine_transaction(&nodes[1], &local_txn[0]);
5438         check_added_monitors!(nodes[1], 1);
5439         let events = nodes[1].node.get_and_clear_pending_msg_events();
5440         match events[0] {
5441                 MessageSendEvent::UpdateHTLCs { .. } => {},
5442                 _ => panic!("Unexpected event"),
5443         }
5444         match events[1] {
5445                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5446                 _ => panic!("Unexepected event"),
5447         }
5448         let node_tx = {
5449                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5450                 assert_eq!(node_txn.len(), 3);
5451                 assert_eq!(node_txn[0], node_txn[2]);
5452                 assert_eq!(node_txn[1], local_txn[0]);
5453                 assert_eq!(node_txn[0].input.len(), 1);
5454                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5455                 check_spends!(node_txn[0], local_txn[0]);
5456                 node_txn[0].clone()
5457         };
5458
5459         mine_transaction(&nodes[1], &node_tx);
5460         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5461
5462         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5463         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5464         assert_eq!(spend_txn.len(), 1);
5465         check_spends!(spend_txn[0], node_tx);
5466 }
5467
5468 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5469         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5470         // unrevoked commitment transaction.
5471         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5472         // a remote RAA before they could be failed backwards (and combinations thereof).
5473         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5474         // use the same payment hashes.
5475         // Thus, we use a six-node network:
5476         //
5477         // A \         / E
5478         //    - C - D -
5479         // B /         \ F
5480         // And test where C fails back to A/B when D announces its latest commitment transaction
5481         let chanmon_cfgs = create_chanmon_cfgs(6);
5482         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5483         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5484         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5485         let logger = test_utils::TestLogger::new();
5486
5487         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5488         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5489         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5490         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5491         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5492
5493         // Rebalance and check output sanity...
5494         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5495         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5496         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5497
5498         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5499         // 0th HTLC:
5500         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
5501         // 1st HTLC:
5502         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
5503         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5504         let our_node_id = &nodes[1].node.get_our_node_id();
5505         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();
5506         // 2nd HTLC:
5507         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
5508         // 3rd HTLC:
5509         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
5510         // 4th HTLC:
5511         let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5512         // 5th HTLC:
5513         let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5514         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();
5515         // 6th HTLC:
5516         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());
5517         // 7th HTLC:
5518         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());
5519
5520         // 8th HTLC:
5521         let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5522         // 9th HTLC:
5523         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();
5524         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
5525
5526         // 10th HTLC:
5527         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
5528         // 11th HTLC:
5529         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();
5530         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());
5531
5532         // Double-check that six of the new HTLC were added
5533         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5534         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5535         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5536         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5537
5538         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5539         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5540         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5541         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5542         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5543         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5544         check_added_monitors!(nodes[4], 0);
5545         expect_pending_htlcs_forwardable!(nodes[4]);
5546         check_added_monitors!(nodes[4], 1);
5547
5548         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5549         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5550         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5551         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5552         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5553         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5554
5555         // Fail 3rd below-dust and 7th above-dust HTLCs
5556         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5557         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5558         check_added_monitors!(nodes[5], 0);
5559         expect_pending_htlcs_forwardable!(nodes[5]);
5560         check_added_monitors!(nodes[5], 1);
5561
5562         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5563         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5564         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5565         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5566
5567         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5568
5569         expect_pending_htlcs_forwardable!(nodes[3]);
5570         check_added_monitors!(nodes[3], 1);
5571         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5572         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5573         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5574         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5575         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5576         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5577         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5578         if deliver_last_raa {
5579                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5580         } else {
5581                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5582         }
5583
5584         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5585         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5586         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5587         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5588         //
5589         // We now broadcast the latest commitment transaction, which *should* result in failures for
5590         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5591         // the non-broadcast above-dust HTLCs.
5592         //
5593         // Alternatively, we may broadcast the previous commitment transaction, which should only
5594         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5595         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5596
5597         if announce_latest {
5598                 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5599         } else {
5600                 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5601         }
5602         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5603         check_closed_broadcast!(nodes[2], true);
5604         expect_pending_htlcs_forwardable!(nodes[2]);
5605         check_added_monitors!(nodes[2], 3);
5606
5607         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5608         assert_eq!(cs_msgs.len(), 2);
5609         let mut a_done = false;
5610         for msg in cs_msgs {
5611                 match msg {
5612                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5613                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5614                                 // should be failed-backwards here.
5615                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5616                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5617                                         for htlc in &updates.update_fail_htlcs {
5618                                                 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 });
5619                                         }
5620                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5621                                         assert!(!a_done);
5622                                         a_done = true;
5623                                         &nodes[0]
5624                                 } else {
5625                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5626                                         for htlc in &updates.update_fail_htlcs {
5627                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5628                                         }
5629                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5630                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5631                                         &nodes[1]
5632                                 };
5633                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5634                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5635                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5636                                 if announce_latest {
5637                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5638                                         if *node_id == nodes[0].node.get_our_node_id() {
5639                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5640                                         }
5641                                 }
5642                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5643                         },
5644                         _ => panic!("Unexpected event"),
5645                 }
5646         }
5647
5648         let as_events = nodes[0].node.get_and_clear_pending_events();
5649         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5650         let mut as_failds = HashSet::new();
5651         for event in as_events.iter() {
5652                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5653                         assert!(as_failds.insert(*payment_hash));
5654                         if *payment_hash != payment_hash_2 {
5655                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5656                         } else {
5657                                 assert!(!rejected_by_dest);
5658                         }
5659                 } else { panic!("Unexpected event"); }
5660         }
5661         assert!(as_failds.contains(&payment_hash_1));
5662         assert!(as_failds.contains(&payment_hash_2));
5663         if announce_latest {
5664                 assert!(as_failds.contains(&payment_hash_3));
5665                 assert!(as_failds.contains(&payment_hash_5));
5666         }
5667         assert!(as_failds.contains(&payment_hash_6));
5668
5669         let bs_events = nodes[1].node.get_and_clear_pending_events();
5670         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5671         let mut bs_failds = HashSet::new();
5672         for event in bs_events.iter() {
5673                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5674                         assert!(bs_failds.insert(*payment_hash));
5675                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5676                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5677                         } else {
5678                                 assert!(!rejected_by_dest);
5679                         }
5680                 } else { panic!("Unexpected event"); }
5681         }
5682         assert!(bs_failds.contains(&payment_hash_1));
5683         assert!(bs_failds.contains(&payment_hash_2));
5684         if announce_latest {
5685                 assert!(bs_failds.contains(&payment_hash_4));
5686         }
5687         assert!(bs_failds.contains(&payment_hash_5));
5688
5689         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5690         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5691         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5692         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5693         // PaymentFailureNetworkUpdates.
5694         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5695         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5696         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5697         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5698         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5699                 match event {
5700                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5701                         _ => panic!("Unexpected event"),
5702                 }
5703         }
5704 }
5705
5706 #[test]
5707 fn test_fail_backwards_latest_remote_announce_a() {
5708         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5709 }
5710
5711 #[test]
5712 fn test_fail_backwards_latest_remote_announce_b() {
5713         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5714 }
5715
5716 #[test]
5717 fn test_fail_backwards_previous_remote_announce() {
5718         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5719         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5720         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5721 }
5722
5723 #[test]
5724 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5725         let chanmon_cfgs = create_chanmon_cfgs(2);
5726         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5727         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5728         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5729
5730         // Create some initial channels
5731         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5732
5733         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5734         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5735         assert_eq!(local_txn[0].input.len(), 1);
5736         check_spends!(local_txn[0], chan_1.3);
5737
5738         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5739         mine_transaction(&nodes[0], &local_txn[0]);
5740         check_closed_broadcast!(nodes[0], true);
5741         check_added_monitors!(nodes[0], 1);
5742
5743         let htlc_timeout = {
5744                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5745                 assert_eq!(node_txn[0].input.len(), 1);
5746                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5747                 check_spends!(node_txn[0], local_txn[0]);
5748                 node_txn[0].clone()
5749         };
5750
5751         mine_transaction(&nodes[0], &htlc_timeout);
5752         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5753         expect_payment_failed!(nodes[0], our_payment_hash, true);
5754
5755         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5756         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5757         assert_eq!(spend_txn.len(), 3);
5758         check_spends!(spend_txn[0], local_txn[0]);
5759         check_spends!(spend_txn[1], htlc_timeout);
5760         check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5761 }
5762
5763 #[test]
5764 fn test_key_derivation_params() {
5765         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5766         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5767         // let us re-derive the channel key set to then derive a delayed_payment_key.
5768
5769         let chanmon_cfgs = create_chanmon_cfgs(3);
5770
5771         // We manually create the node configuration to backup the seed.
5772         let seed = [42; 32];
5773         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5774         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);
5775         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 };
5776         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5777         node_cfgs.remove(0);
5778         node_cfgs.insert(0, node);
5779
5780         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5781         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5782
5783         // Create some initial channels
5784         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5785         // for node 0
5786         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5787         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5788         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5789
5790         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5791         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5792         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5793         assert_eq!(local_txn_1[0].input.len(), 1);
5794         check_spends!(local_txn_1[0], chan_1.3);
5795
5796         // We check funding pubkey are unique
5797         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]));
5798         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]));
5799         if from_0_funding_key_0 == from_1_funding_key_0
5800             || from_0_funding_key_0 == from_1_funding_key_1
5801             || from_0_funding_key_1 == from_1_funding_key_0
5802             || from_0_funding_key_1 == from_1_funding_key_1 {
5803                 panic!("Funding pubkeys aren't unique");
5804         }
5805
5806         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5807         mine_transaction(&nodes[0], &local_txn_1[0]);
5808         check_closed_broadcast!(nodes[0], true);
5809         check_added_monitors!(nodes[0], 1);
5810
5811         let htlc_timeout = {
5812                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5813                 assert_eq!(node_txn[0].input.len(), 1);
5814                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5815                 check_spends!(node_txn[0], local_txn_1[0]);
5816                 node_txn[0].clone()
5817         };
5818
5819         mine_transaction(&nodes[0], &htlc_timeout);
5820         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5821         expect_payment_failed!(nodes[0], our_payment_hash, true);
5822
5823         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5824         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5825         let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5826         assert_eq!(spend_txn.len(), 3);
5827         check_spends!(spend_txn[0], local_txn_1[0]);
5828         check_spends!(spend_txn[1], htlc_timeout);
5829         check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5830 }
5831
5832 #[test]
5833 fn test_static_output_closing_tx() {
5834         let chanmon_cfgs = create_chanmon_cfgs(2);
5835         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5836         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5837         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5838
5839         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5840
5841         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5842         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5843
5844         mine_transaction(&nodes[0], &closing_tx);
5845         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5846
5847         let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5848         assert_eq!(spend_txn.len(), 1);
5849         check_spends!(spend_txn[0], closing_tx);
5850
5851         mine_transaction(&nodes[1], &closing_tx);
5852         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5853
5854         let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5855         assert_eq!(spend_txn.len(), 1);
5856         check_spends!(spend_txn[0], closing_tx);
5857 }
5858
5859 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5860         let chanmon_cfgs = create_chanmon_cfgs(2);
5861         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5862         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5863         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5864         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5865
5866         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5867
5868         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5869         // present in B's local commitment transaction, but none of A's commitment transactions.
5870         assert!(nodes[1].node.claim_funds(our_payment_preimage));
5871         check_added_monitors!(nodes[1], 1);
5872
5873         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5874         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5875         let events = nodes[0].node.get_and_clear_pending_events();
5876         assert_eq!(events.len(), 1);
5877         match events[0] {
5878                 Event::PaymentSent { payment_preimage } => {
5879                         assert_eq!(payment_preimage, our_payment_preimage);
5880                 },
5881                 _ => panic!("Unexpected event"),
5882         }
5883
5884         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5885         check_added_monitors!(nodes[0], 1);
5886         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5887         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5888         check_added_monitors!(nodes[1], 1);
5889
5890         let starting_block = nodes[1].best_block_info();
5891         let mut block = Block {
5892                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5893                 txdata: vec![],
5894         };
5895         for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5896                 connect_block(&nodes[1], &block);
5897                 block.header.prev_blockhash = block.block_hash();
5898         }
5899         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5900         check_closed_broadcast!(nodes[1], true);
5901         check_added_monitors!(nodes[1], 1);
5902 }
5903
5904 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5905         let chanmon_cfgs = create_chanmon_cfgs(2);
5906         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5907         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5908         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5909         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5910         let logger = test_utils::TestLogger::new();
5911
5912         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
5913         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5914         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();
5915         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5916         check_added_monitors!(nodes[0], 1);
5917
5918         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5919
5920         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5921         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5922         // to "time out" the HTLC.
5923
5924         let starting_block = nodes[1].best_block_info();
5925         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5926
5927         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5928                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5929                 header.prev_blockhash = header.block_hash();
5930         }
5931         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5932         check_closed_broadcast!(nodes[0], true);
5933         check_added_monitors!(nodes[0], 1);
5934 }
5935
5936 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5937         let chanmon_cfgs = create_chanmon_cfgs(3);
5938         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5939         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5940         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5941         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5942
5943         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5944         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5945         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5946         // actually revoked.
5947         let htlc_value = if use_dust { 50000 } else { 3000000 };
5948         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5949         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
5950         expect_pending_htlcs_forwardable!(nodes[1]);
5951         check_added_monitors!(nodes[1], 1);
5952
5953         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5954         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5955         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5956         check_added_monitors!(nodes[0], 1);
5957         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5958         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5959         check_added_monitors!(nodes[1], 1);
5960         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5961         check_added_monitors!(nodes[1], 1);
5962         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5963
5964         if check_revoke_no_close {
5965                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5966                 check_added_monitors!(nodes[0], 1);
5967         }
5968
5969         let starting_block = nodes[1].best_block_info();
5970         let mut block = Block {
5971                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5972                 txdata: vec![],
5973         };
5974         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
5975                 connect_block(&nodes[0], &block);
5976                 block.header.prev_blockhash = block.block_hash();
5977         }
5978         if !check_revoke_no_close {
5979                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5980                 check_closed_broadcast!(nodes[0], true);
5981                 check_added_monitors!(nodes[0], 1);
5982         } else {
5983                 expect_payment_failed!(nodes[0], our_payment_hash, true);
5984         }
5985 }
5986
5987 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5988 // There are only a few cases to test here:
5989 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5990 //    broadcastable commitment transactions result in channel closure,
5991 //  * its included in an unrevoked-but-previous remote commitment transaction,
5992 //  * its included in the latest remote or local commitment transactions.
5993 // We test each of the three possible commitment transactions individually and use both dust and
5994 // non-dust HTLCs.
5995 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5996 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5997 // tested for at least one of the cases in other tests.
5998 #[test]
5999 fn htlc_claim_single_commitment_only_a() {
6000         do_htlc_claim_local_commitment_only(true);
6001         do_htlc_claim_local_commitment_only(false);
6002
6003         do_htlc_claim_current_remote_commitment_only(true);
6004         do_htlc_claim_current_remote_commitment_only(false);
6005 }
6006
6007 #[test]
6008 fn htlc_claim_single_commitment_only_b() {
6009         do_htlc_claim_previous_remote_commitment_only(true, false);
6010         do_htlc_claim_previous_remote_commitment_only(false, false);
6011         do_htlc_claim_previous_remote_commitment_only(true, true);
6012         do_htlc_claim_previous_remote_commitment_only(false, true);
6013 }
6014
6015 #[test]
6016 #[should_panic]
6017 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6018         let chanmon_cfgs = create_chanmon_cfgs(2);
6019         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6020         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6021         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6022         //Force duplicate channel ids
6023         for node in nodes.iter() {
6024                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6025         }
6026
6027         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6028         let channel_value_satoshis=10000;
6029         let push_msat=10001;
6030         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6031         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6032         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6033
6034         //Create a second channel with a channel_id collision
6035         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6036 }
6037
6038 #[test]
6039 fn bolt2_open_channel_sending_node_checks_part2() {
6040         let chanmon_cfgs = create_chanmon_cfgs(2);
6041         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6042         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6043         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6044
6045         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6046         let channel_value_satoshis=2^24;
6047         let push_msat=10001;
6048         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6049
6050         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6051         let channel_value_satoshis=10000;
6052         // Test when push_msat is equal to 1000 * funding_satoshis.
6053         let push_msat=1000*channel_value_satoshis+1;
6054         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6055
6056         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6057         let channel_value_satoshis=10000;
6058         let push_msat=10001;
6059         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
6060         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6061         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6062
6063         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6064         // 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
6065         assert!(node0_to_1_send_open_channel.channel_flags<=1);
6066
6067         // 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.
6068         assert!(BREAKDOWN_TIMEOUT>0);
6069         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6070
6071         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6072         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6073         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6074
6075         // 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.
6076         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6077         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6078         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6079         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6080         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6081 }
6082
6083 #[test]
6084 fn bolt2_open_channel_sane_dust_limit() {
6085         let chanmon_cfgs = create_chanmon_cfgs(2);
6086         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6087         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6088         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6089
6090         let channel_value_satoshis=1000000;
6091         let push_msat=10001;
6092         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6093         let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6094         node0_to_1_send_open_channel.dust_limit_satoshis = 661;
6095         node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
6096
6097         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6098         let events = nodes[1].node.get_and_clear_pending_msg_events();
6099         let err_msg = match events[0] {
6100                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
6101                         msg.clone()
6102                 },
6103                 _ => panic!("Unexpected event"),
6104         };
6105         assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
6106 }
6107
6108 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6109 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6110 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6111 // is no longer affordable once it's freed.
6112 #[test]
6113 fn test_fail_holding_cell_htlc_upon_free() {
6114         let chanmon_cfgs = create_chanmon_cfgs(2);
6115         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6116         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6117         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6118         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6119         let logger = test_utils::TestLogger::new();
6120
6121         // First nodes[0] generates an update_fee, setting the channel's
6122         // pending_update_fee.
6123         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6124         check_added_monitors!(nodes[0], 1);
6125
6126         let events = nodes[0].node.get_and_clear_pending_msg_events();
6127         assert_eq!(events.len(), 1);
6128         let (update_msg, commitment_signed) = match events[0] {
6129                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6130                         (update_fee.as_ref(), commitment_signed)
6131                 },
6132                 _ => panic!("Unexpected event"),
6133         };
6134
6135         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6136
6137         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6138         let channel_reserve = chan_stat.channel_reserve_msat;
6139         let feerate = get_feerate!(nodes[0], chan.2);
6140
6141         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6142         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6143         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6144         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6145         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();
6146
6147         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6148         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6149         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6150         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6151
6152         // Flush the pending fee update.
6153         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6154         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6155         check_added_monitors!(nodes[1], 1);
6156         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6157         check_added_monitors!(nodes[0], 1);
6158
6159         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6160         // HTLC, but now that the fee has been raised the payment will now fail, causing
6161         // us to surface its failure to the user.
6162         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6163         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6164         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 1 HTLC updates".to_string(), 1);
6165         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);
6166         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6167
6168         // Check that the payment failed to be sent out.
6169         let events = nodes[0].node.get_and_clear_pending_events();
6170         assert_eq!(events.len(), 1);
6171         match &events[0] {
6172                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6173                         assert_eq!(our_payment_hash.clone(), *payment_hash);
6174                         assert_eq!(*rejected_by_dest, false);
6175                         assert_eq!(*error_code, None);
6176                         assert_eq!(*error_data, None);
6177                 },
6178                 _ => panic!("Unexpected event"),
6179         }
6180 }
6181
6182 // Test that if multiple HTLCs are released from the holding cell and one is
6183 // valid but the other is no longer valid upon release, the valid HTLC can be
6184 // successfully completed while the other one fails as expected.
6185 #[test]
6186 fn test_free_and_fail_holding_cell_htlcs() {
6187         let chanmon_cfgs = create_chanmon_cfgs(2);
6188         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6189         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6190         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6191         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6192         let logger = test_utils::TestLogger::new();
6193
6194         // First nodes[0] generates an update_fee, setting the channel's
6195         // pending_update_fee.
6196         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6197         check_added_monitors!(nodes[0], 1);
6198
6199         let events = nodes[0].node.get_and_clear_pending_msg_events();
6200         assert_eq!(events.len(), 1);
6201         let (update_msg, commitment_signed) = match events[0] {
6202                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6203                         (update_fee.as_ref(), commitment_signed)
6204                 },
6205                 _ => panic!("Unexpected event"),
6206         };
6207
6208         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6209
6210         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6211         let channel_reserve = chan_stat.channel_reserve_msat;
6212         let feerate = get_feerate!(nodes[0], chan.2);
6213
6214         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6215         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6216         let amt_1 = 20000;
6217         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6218         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6219         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6220         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();
6221         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();
6222
6223         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6224         nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6225         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6226         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6227         nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6228         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6229         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6230
6231         // Flush the pending fee update.
6232         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6233         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6234         check_added_monitors!(nodes[1], 1);
6235         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6236         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6237         check_added_monitors!(nodes[0], 2);
6238
6239         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6240         // but now that the fee has been raised the second payment will now fail, causing us
6241         // to surface its failure to the user. The first payment should succeed.
6242         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6243         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6244         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 2 HTLC updates".to_string(), 1);
6245         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);
6246         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6247
6248         // Check that the second payment failed to be sent out.
6249         let events = nodes[0].node.get_and_clear_pending_events();
6250         assert_eq!(events.len(), 1);
6251         match &events[0] {
6252                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6253                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6254                         assert_eq!(*rejected_by_dest, false);
6255                         assert_eq!(*error_code, None);
6256                         assert_eq!(*error_data, None);
6257                 },
6258                 _ => panic!("Unexpected event"),
6259         }
6260
6261         // Complete the first payment and the RAA from the fee update.
6262         let (payment_event, send_raa_event) = {
6263                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6264                 assert_eq!(msgs.len(), 2);
6265                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6266         };
6267         let raa = match send_raa_event {
6268                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6269                 _ => panic!("Unexpected event"),
6270         };
6271         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6272         check_added_monitors!(nodes[1], 1);
6273         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6274         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6275         let events = nodes[1].node.get_and_clear_pending_events();
6276         assert_eq!(events.len(), 1);
6277         match events[0] {
6278                 Event::PendingHTLCsForwardable { .. } => {},
6279                 _ => panic!("Unexpected event"),
6280         }
6281         nodes[1].node.process_pending_htlc_forwards();
6282         let events = nodes[1].node.get_and_clear_pending_events();
6283         assert_eq!(events.len(), 1);
6284         match events[0] {
6285                 Event::PaymentReceived { .. } => {},
6286                 _ => panic!("Unexpected event"),
6287         }
6288         nodes[1].node.claim_funds(payment_preimage_1);
6289         check_added_monitors!(nodes[1], 1);
6290         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6291         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6292         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6293         let events = nodes[0].node.get_and_clear_pending_events();
6294         assert_eq!(events.len(), 1);
6295         match events[0] {
6296                 Event::PaymentSent { ref payment_preimage } => {
6297                         assert_eq!(*payment_preimage, payment_preimage_1);
6298                 }
6299                 _ => panic!("Unexpected event"),
6300         }
6301 }
6302
6303 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6304 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6305 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6306 // once it's freed.
6307 #[test]
6308 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6309         let chanmon_cfgs = create_chanmon_cfgs(3);
6310         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6311         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6312         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6313         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6314         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6315         let logger = test_utils::TestLogger::new();
6316
6317         // First nodes[1] generates an update_fee, setting the channel's
6318         // pending_update_fee.
6319         nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6320         check_added_monitors!(nodes[1], 1);
6321
6322         let events = nodes[1].node.get_and_clear_pending_msg_events();
6323         assert_eq!(events.len(), 1);
6324         let (update_msg, commitment_signed) = match events[0] {
6325                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6326                         (update_fee.as_ref(), commitment_signed)
6327                 },
6328                 _ => panic!("Unexpected event"),
6329         };
6330
6331         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6332
6333         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6334         let channel_reserve = chan_stat.channel_reserve_msat;
6335         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6336
6337         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6338         let feemsat = 239;
6339         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6340         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6341         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6342         let payment_event = {
6343                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6344                 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();
6345                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6346                 check_added_monitors!(nodes[0], 1);
6347
6348                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6349                 assert_eq!(events.len(), 1);
6350
6351                 SendEvent::from_event(events.remove(0))
6352         };
6353         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6354         check_added_monitors!(nodes[1], 0);
6355         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6356         expect_pending_htlcs_forwardable!(nodes[1]);
6357
6358         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6359         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6360
6361         // Flush the pending fee update.
6362         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6363         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6364         check_added_monitors!(nodes[2], 1);
6365         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6366         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6367         check_added_monitors!(nodes[1], 2);
6368
6369         // A final RAA message is generated to finalize the fee update.
6370         let events = nodes[1].node.get_and_clear_pending_msg_events();
6371         assert_eq!(events.len(), 1);
6372
6373         let raa_msg = match &events[0] {
6374                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6375                         msg.clone()
6376                 },
6377                 _ => panic!("Unexpected event"),
6378         };
6379
6380         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6381         check_added_monitors!(nodes[2], 1);
6382         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6383
6384         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6385         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6386         assert_eq!(process_htlc_forwards_event.len(), 1);
6387         match &process_htlc_forwards_event[0] {
6388                 &Event::PendingHTLCsForwardable { .. } => {},
6389                 _ => panic!("Unexpected event"),
6390         }
6391
6392         // In response, we call ChannelManager's process_pending_htlc_forwards
6393         nodes[1].node.process_pending_htlc_forwards();
6394         check_added_monitors!(nodes[1], 1);
6395
6396         // This causes the HTLC to be failed backwards.
6397         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6398         assert_eq!(fail_event.len(), 1);
6399         let (fail_msg, commitment_signed) = match &fail_event[0] {
6400                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6401                         assert_eq!(updates.update_add_htlcs.len(), 0);
6402                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6403                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6404                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6405                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6406                 },
6407                 _ => panic!("Unexpected event"),
6408         };
6409
6410         // Pass the failure messages back to nodes[0].
6411         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6412         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6413
6414         // Complete the HTLC failure+removal process.
6415         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6416         check_added_monitors!(nodes[0], 1);
6417         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6418         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6419         check_added_monitors!(nodes[1], 2);
6420         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6421         assert_eq!(final_raa_event.len(), 1);
6422         let raa = match &final_raa_event[0] {
6423                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6424                 _ => panic!("Unexpected event"),
6425         };
6426         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6427         let fail_msg_event = nodes[0].node.get_and_clear_pending_msg_events();
6428         assert_eq!(fail_msg_event.len(), 1);
6429         match &fail_msg_event[0] {
6430                 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
6431                 _ => panic!("Unexpected event"),
6432         }
6433         let failure_event = nodes[0].node.get_and_clear_pending_events();
6434         assert_eq!(failure_event.len(), 1);
6435         match &failure_event[0] {
6436                 &Event::PaymentFailed { rejected_by_dest, .. } => {
6437                         assert!(!rejected_by_dest);
6438                 },
6439                 _ => panic!("Unexpected event"),
6440         }
6441         check_added_monitors!(nodes[0], 1);
6442 }
6443
6444 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6445 // 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.
6446 //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.
6447
6448 #[test]
6449 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6450         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6451         let chanmon_cfgs = create_chanmon_cfgs(2);
6452         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6453         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6454         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6455         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6456
6457         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6458         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6459         let logger = test_utils::TestLogger::new();
6460         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();
6461         route.paths[0][0].fee_msat = 100;
6462
6463         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6464                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6465         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6466         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6467 }
6468
6469 #[test]
6470 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6471         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6472         let chanmon_cfgs = create_chanmon_cfgs(2);
6473         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6474         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6475         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6476         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6477         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6478
6479         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6480         let logger = test_utils::TestLogger::new();
6481         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();
6482         route.paths[0][0].fee_msat = 0;
6483         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6484                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6485
6486         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6487         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6488 }
6489
6490 #[test]
6491 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6492         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6493         let chanmon_cfgs = create_chanmon_cfgs(2);
6494         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6495         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6496         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6497         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6498
6499         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6500         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6501         let logger = test_utils::TestLogger::new();
6502         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();
6503         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6504         check_added_monitors!(nodes[0], 1);
6505         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6506         updates.update_add_htlcs[0].amount_msat = 0;
6507
6508         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6509         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6510         check_closed_broadcast!(nodes[1], true).unwrap();
6511         check_added_monitors!(nodes[1], 1);
6512 }
6513
6514 #[test]
6515 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6516         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6517         //It is enforced when constructing a route.
6518         let chanmon_cfgs = create_chanmon_cfgs(2);
6519         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6520         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6521         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6522         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6523         let logger = test_utils::TestLogger::new();
6524
6525         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6526
6527         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6528         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();
6529         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6530                 assert_eq!(err, &"Channel CLTV overflowed?"));
6531 }
6532
6533 #[test]
6534 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6535         //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.
6536         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6537         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6538         let chanmon_cfgs = create_chanmon_cfgs(2);
6539         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6540         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6541         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6542         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6543         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6544
6545         let logger = test_utils::TestLogger::new();
6546         for i in 0..max_accepted_htlcs {
6547                 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6548                 let payment_event = {
6549                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6550                         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();
6551                         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6552                         check_added_monitors!(nodes[0], 1);
6553
6554                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6555                         assert_eq!(events.len(), 1);
6556                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6557                                 assert_eq!(htlcs[0].htlc_id, i);
6558                         } else {
6559                                 assert!(false);
6560                         }
6561                         SendEvent::from_event(events.remove(0))
6562                 };
6563                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6564                 check_added_monitors!(nodes[1], 0);
6565                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6566
6567                 expect_pending_htlcs_forwardable!(nodes[1]);
6568                 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6569         }
6570         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6571         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6572         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();
6573         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6574                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6575
6576         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6577         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6578 }
6579
6580 #[test]
6581 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6582         //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.
6583         let chanmon_cfgs = create_chanmon_cfgs(2);
6584         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6585         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6586         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6587         let channel_value = 100000;
6588         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6589         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6590
6591         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6592
6593         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6594         // Manually create a route over our max in flight (which our router normally automatically
6595         // limits us to.
6596         let route = Route { paths: vec![vec![RouteHop {
6597            pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6598            short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6599            fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6600         }]] };
6601         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6602                 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)));
6603
6604         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6605         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);
6606
6607         send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6608 }
6609
6610 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6611 #[test]
6612 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6613         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6614         let chanmon_cfgs = create_chanmon_cfgs(2);
6615         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6616         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6617         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6618         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6619         let htlc_minimum_msat: u64;
6620         {
6621                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6622                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6623                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6624         }
6625
6626         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6627         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6628         let logger = test_utils::TestLogger::new();
6629         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();
6630         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6631         check_added_monitors!(nodes[0], 1);
6632         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6633         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6634         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6635         assert!(nodes[1].node.list_channels().is_empty());
6636         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6637         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()));
6638         check_added_monitors!(nodes[1], 1);
6639 }
6640
6641 #[test]
6642 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6643         //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
6644         let chanmon_cfgs = create_chanmon_cfgs(2);
6645         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6646         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6647         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6648         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6649         let logger = test_utils::TestLogger::new();
6650
6651         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6652         let channel_reserve = chan_stat.channel_reserve_msat;
6653         let feerate = get_feerate!(nodes[0], chan.2);
6654         // The 2* and +1 are for the fee spike reserve.
6655         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6656
6657         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6658         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6659         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6660         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();
6661         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6662         check_added_monitors!(nodes[0], 1);
6663         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6664
6665         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6666         // at this time channel-initiatee receivers are not required to enforce that senders
6667         // respect the fee_spike_reserve.
6668         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6669         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6670
6671         assert!(nodes[1].node.list_channels().is_empty());
6672         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6673         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6674         check_added_monitors!(nodes[1], 1);
6675 }
6676
6677 #[test]
6678 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6679         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6680         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6681         let chanmon_cfgs = create_chanmon_cfgs(2);
6682         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6683         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6684         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6685         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6686         let logger = test_utils::TestLogger::new();
6687
6688         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6689         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6690
6691         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6692         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();
6693
6694         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6695         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6696         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height).unwrap();
6697         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6698
6699         let mut msg = msgs::UpdateAddHTLC {
6700                 channel_id: chan.2,
6701                 htlc_id: 0,
6702                 amount_msat: 1000,
6703                 payment_hash: our_payment_hash,
6704                 cltv_expiry: htlc_cltv,
6705                 onion_routing_packet: onion_packet.clone(),
6706         };
6707
6708         for i in 0..super::channel::OUR_MAX_HTLCS {
6709                 msg.htlc_id = i as u64;
6710                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6711         }
6712         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6713         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6714
6715         assert!(nodes[1].node.list_channels().is_empty());
6716         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6717         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6718         check_added_monitors!(nodes[1], 1);
6719 }
6720
6721 #[test]
6722 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6723         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6724         let chanmon_cfgs = create_chanmon_cfgs(2);
6725         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6726         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6727         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6728         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6729         let logger = test_utils::TestLogger::new();
6730
6731         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6732         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6733         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();
6734         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6735         check_added_monitors!(nodes[0], 1);
6736         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6737         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6738         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6739
6740         assert!(nodes[1].node.list_channels().is_empty());
6741         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6742         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6743         check_added_monitors!(nodes[1], 1);
6744 }
6745
6746 #[test]
6747 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6748         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6749         let chanmon_cfgs = create_chanmon_cfgs(2);
6750         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6751         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6752         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6753         let logger = test_utils::TestLogger::new();
6754
6755         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6756         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6757         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6758         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();
6759         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6760         check_added_monitors!(nodes[0], 1);
6761         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6762         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6763         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6764
6765         assert!(nodes[1].node.list_channels().is_empty());
6766         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6767         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6768         check_added_monitors!(nodes[1], 1);
6769 }
6770
6771 #[test]
6772 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6773         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6774         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6775         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6776         let chanmon_cfgs = create_chanmon_cfgs(2);
6777         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6778         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6779         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6780         let logger = test_utils::TestLogger::new();
6781
6782         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6783         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6784         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6785         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();
6786         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6787         check_added_monitors!(nodes[0], 1);
6788         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6789         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6790
6791         //Disconnect and Reconnect
6792         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6793         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6794         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6795         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6796         assert_eq!(reestablish_1.len(), 1);
6797         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6798         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6799         assert_eq!(reestablish_2.len(), 1);
6800         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6801         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6802         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6803         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6804
6805         //Resend HTLC
6806         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6807         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6808         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6809         check_added_monitors!(nodes[1], 1);
6810         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6811
6812         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6813
6814         assert!(nodes[1].node.list_channels().is_empty());
6815         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6816         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6817         check_added_monitors!(nodes[1], 1);
6818 }
6819
6820 #[test]
6821 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6822         //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.
6823
6824         let chanmon_cfgs = create_chanmon_cfgs(2);
6825         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6826         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6827         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6828         let logger = test_utils::TestLogger::new();
6829         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6830         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6831         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6832         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();
6833         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6834
6835         check_added_monitors!(nodes[0], 1);
6836         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6837         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6838
6839         let update_msg = msgs::UpdateFulfillHTLC{
6840                 channel_id: chan.2,
6841                 htlc_id: 0,
6842                 payment_preimage: our_payment_preimage,
6843         };
6844
6845         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6846
6847         assert!(nodes[0].node.list_channels().is_empty());
6848         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6849         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()));
6850         check_added_monitors!(nodes[0], 1);
6851 }
6852
6853 #[test]
6854 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6855         //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.
6856
6857         let chanmon_cfgs = create_chanmon_cfgs(2);
6858         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6859         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6860         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6861         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6862         let logger = test_utils::TestLogger::new();
6863
6864         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6865         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6866         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();
6867         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6868         check_added_monitors!(nodes[0], 1);
6869         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6870         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6871
6872         let update_msg = msgs::UpdateFailHTLC{
6873                 channel_id: chan.2,
6874                 htlc_id: 0,
6875                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6876         };
6877
6878         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6879
6880         assert!(nodes[0].node.list_channels().is_empty());
6881         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6882         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()));
6883         check_added_monitors!(nodes[0], 1);
6884 }
6885
6886 #[test]
6887 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6888         //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.
6889
6890         let chanmon_cfgs = create_chanmon_cfgs(2);
6891         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6892         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6893         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6894         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6895         let logger = test_utils::TestLogger::new();
6896
6897         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6898         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6899         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();
6900         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6901         check_added_monitors!(nodes[0], 1);
6902         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6903         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6904         let update_msg = msgs::UpdateFailMalformedHTLC{
6905                 channel_id: chan.2,
6906                 htlc_id: 0,
6907                 sha256_of_onion: [1; 32],
6908                 failure_code: 0x8000,
6909         };
6910
6911         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6912
6913         assert!(nodes[0].node.list_channels().is_empty());
6914         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6915         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()));
6916         check_added_monitors!(nodes[0], 1);
6917 }
6918
6919 #[test]
6920 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6921         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6922
6923         let chanmon_cfgs = create_chanmon_cfgs(2);
6924         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6925         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6926         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6927         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6928
6929         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6930
6931         nodes[1].node.claim_funds(our_payment_preimage);
6932         check_added_monitors!(nodes[1], 1);
6933
6934         let events = nodes[1].node.get_and_clear_pending_msg_events();
6935         assert_eq!(events.len(), 1);
6936         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6937                 match events[0] {
6938                         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, .. } } => {
6939                                 assert!(update_add_htlcs.is_empty());
6940                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6941                                 assert!(update_fail_htlcs.is_empty());
6942                                 assert!(update_fail_malformed_htlcs.is_empty());
6943                                 assert!(update_fee.is_none());
6944                                 update_fulfill_htlcs[0].clone()
6945                         },
6946                         _ => panic!("Unexpected event"),
6947                 }
6948         };
6949
6950         update_fulfill_msg.htlc_id = 1;
6951
6952         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6953
6954         assert!(nodes[0].node.list_channels().is_empty());
6955         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6956         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6957         check_added_monitors!(nodes[0], 1);
6958 }
6959
6960 #[test]
6961 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6962         //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.
6963
6964         let chanmon_cfgs = create_chanmon_cfgs(2);
6965         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6966         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6967         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6968         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6969
6970         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6971
6972         nodes[1].node.claim_funds(our_payment_preimage);
6973         check_added_monitors!(nodes[1], 1);
6974
6975         let events = nodes[1].node.get_and_clear_pending_msg_events();
6976         assert_eq!(events.len(), 1);
6977         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6978                 match events[0] {
6979                         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, .. } } => {
6980                                 assert!(update_add_htlcs.is_empty());
6981                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6982                                 assert!(update_fail_htlcs.is_empty());
6983                                 assert!(update_fail_malformed_htlcs.is_empty());
6984                                 assert!(update_fee.is_none());
6985                                 update_fulfill_htlcs[0].clone()
6986                         },
6987                         _ => panic!("Unexpected event"),
6988                 }
6989         };
6990
6991         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6992
6993         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6994
6995         assert!(nodes[0].node.list_channels().is_empty());
6996         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6997         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6998         check_added_monitors!(nodes[0], 1);
6999 }
7000
7001 #[test]
7002 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
7003         //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.
7004
7005         let chanmon_cfgs = create_chanmon_cfgs(2);
7006         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7007         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7008         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7009         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7010         let logger = test_utils::TestLogger::new();
7011
7012         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7013         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7014         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();
7015         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7016         check_added_monitors!(nodes[0], 1);
7017
7018         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7019         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7020
7021         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7022         check_added_monitors!(nodes[1], 0);
7023         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7024
7025         let events = nodes[1].node.get_and_clear_pending_msg_events();
7026
7027         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7028                 match events[0] {
7029                         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, .. } } => {
7030                                 assert!(update_add_htlcs.is_empty());
7031                                 assert!(update_fulfill_htlcs.is_empty());
7032                                 assert!(update_fail_htlcs.is_empty());
7033                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7034                                 assert!(update_fee.is_none());
7035                                 update_fail_malformed_htlcs[0].clone()
7036                         },
7037                         _ => panic!("Unexpected event"),
7038                 }
7039         };
7040         update_msg.failure_code &= !0x8000;
7041         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7042
7043         assert!(nodes[0].node.list_channels().is_empty());
7044         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7045         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7046         check_added_monitors!(nodes[0], 1);
7047 }
7048
7049 #[test]
7050 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7051         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7052         //    * 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.
7053
7054         let chanmon_cfgs = create_chanmon_cfgs(3);
7055         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7056         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7057         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7058         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7059         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7060         let logger = test_utils::TestLogger::new();
7061
7062         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7063
7064         //First hop
7065         let mut payment_event = {
7066                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7067                 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();
7068                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7069                 check_added_monitors!(nodes[0], 1);
7070                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7071                 assert_eq!(events.len(), 1);
7072                 SendEvent::from_event(events.remove(0))
7073         };
7074         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7075         check_added_monitors!(nodes[1], 0);
7076         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7077         expect_pending_htlcs_forwardable!(nodes[1]);
7078         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7079         assert_eq!(events_2.len(), 1);
7080         check_added_monitors!(nodes[1], 1);
7081         payment_event = SendEvent::from_event(events_2.remove(0));
7082         assert_eq!(payment_event.msgs.len(), 1);
7083
7084         //Second Hop
7085         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7086         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7087         check_added_monitors!(nodes[2], 0);
7088         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7089
7090         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7091         assert_eq!(events_3.len(), 1);
7092         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7093                 match events_3[0] {
7094                         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 } } => {
7095                                 assert!(update_add_htlcs.is_empty());
7096                                 assert!(update_fulfill_htlcs.is_empty());
7097                                 assert!(update_fail_htlcs.is_empty());
7098                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7099                                 assert!(update_fee.is_none());
7100                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7101                         },
7102                         _ => panic!("Unexpected event"),
7103                 }
7104         };
7105
7106         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7107
7108         check_added_monitors!(nodes[1], 0);
7109         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7110         expect_pending_htlcs_forwardable!(nodes[1]);
7111         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7112         assert_eq!(events_4.len(), 1);
7113
7114         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7115         match events_4[0] {
7116                 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, .. } } => {
7117                         assert!(update_add_htlcs.is_empty());
7118                         assert!(update_fulfill_htlcs.is_empty());
7119                         assert_eq!(update_fail_htlcs.len(), 1);
7120                         assert!(update_fail_malformed_htlcs.is_empty());
7121                         assert!(update_fee.is_none());
7122                 },
7123                 _ => panic!("Unexpected event"),
7124         };
7125
7126         check_added_monitors!(nodes[1], 1);
7127 }
7128
7129 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7130         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7131         // 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
7132         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7133
7134         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7135         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7136         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7137         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7138         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7139         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7140
7141         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7142
7143         // We route 2 dust-HTLCs between A and B
7144         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7145         let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7146         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7147
7148         // Cache one local commitment tx as previous
7149         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7150
7151         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7152         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7153         check_added_monitors!(nodes[1], 0);
7154         expect_pending_htlcs_forwardable!(nodes[1]);
7155         check_added_monitors!(nodes[1], 1);
7156
7157         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7158         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7159         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7160         check_added_monitors!(nodes[0], 1);
7161
7162         // Cache one local commitment tx as lastest
7163         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7164
7165         let events = nodes[0].node.get_and_clear_pending_msg_events();
7166         match events[0] {
7167                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7168                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7169                 },
7170                 _ => panic!("Unexpected event"),
7171         }
7172         match events[1] {
7173                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7174                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7175                 },
7176                 _ => panic!("Unexpected event"),
7177         }
7178
7179         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7180         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7181         if announce_latest {
7182                 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7183         } else {
7184                 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7185         }
7186
7187         check_closed_broadcast!(nodes[0], true);
7188         check_added_monitors!(nodes[0], 1);
7189
7190         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7191         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7192         let events = nodes[0].node.get_and_clear_pending_events();
7193         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7194         assert_eq!(events.len(), 2);
7195         let mut first_failed = false;
7196         for event in events {
7197                 match event {
7198                         Event::PaymentFailed { payment_hash, .. } => {
7199                                 if payment_hash == payment_hash_1 {
7200                                         assert!(!first_failed);
7201                                         first_failed = true;
7202                                 } else {
7203                                         assert_eq!(payment_hash, payment_hash_2);
7204                                 }
7205                         }
7206                         _ => panic!("Unexpected event"),
7207                 }
7208         }
7209 }
7210
7211 #[test]
7212 fn test_failure_delay_dust_htlc_local_commitment() {
7213         do_test_failure_delay_dust_htlc_local_commitment(true);
7214         do_test_failure_delay_dust_htlc_local_commitment(false);
7215 }
7216
7217 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7218         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7219         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7220         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7221         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7222         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7223         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7224
7225         let chanmon_cfgs = create_chanmon_cfgs(3);
7226         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7227         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7228         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7229         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7230
7231         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7232
7233         let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7234         let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7235
7236         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7237         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7238
7239         // We revoked bs_commitment_tx
7240         if revoked {
7241                 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7242                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7243         }
7244
7245         let mut timeout_tx = Vec::new();
7246         if local {
7247                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7248                 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7249                 check_closed_broadcast!(nodes[0], true);
7250                 check_added_monitors!(nodes[0], 1);
7251                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7252                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7253                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7254                 expect_payment_failed!(nodes[0], dust_hash, true);
7255                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7256                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7257                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7258                 mine_transaction(&nodes[0], &timeout_tx[0]);
7259                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7260                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7261         } else {
7262                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7263                 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7264                 check_closed_broadcast!(nodes[0], true);
7265                 check_added_monitors!(nodes[0], 1);
7266                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7267                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7268                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7269                 if !revoked {
7270                         expect_payment_failed!(nodes[0], dust_hash, true);
7271                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7272                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7273                         mine_transaction(&nodes[0], &timeout_tx[0]);
7274                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7275                         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7276                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7277                 } else {
7278                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7279                         // commitment tx
7280                         let events = nodes[0].node.get_and_clear_pending_events();
7281                         assert_eq!(events.len(), 2);
7282                         let first;
7283                         match events[0] {
7284                                 Event::PaymentFailed { payment_hash, .. } => {
7285                                         if payment_hash == dust_hash { first = true; }
7286                                         else { first = false; }
7287                                 },
7288                                 _ => panic!("Unexpected event"),
7289                         }
7290                         match events[1] {
7291                                 Event::PaymentFailed { payment_hash, .. } => {
7292                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7293                                         else { assert_eq!(payment_hash, dust_hash); }
7294                                 },
7295                                 _ => panic!("Unexpected event"),
7296                         }
7297                 }
7298         }
7299 }
7300
7301 #[test]
7302 fn test_sweep_outbound_htlc_failure_update() {
7303         do_test_sweep_outbound_htlc_failure_update(false, true);
7304         do_test_sweep_outbound_htlc_failure_update(false, false);
7305         do_test_sweep_outbound_htlc_failure_update(true, false);
7306 }
7307
7308 #[test]
7309 fn test_upfront_shutdown_script() {
7310         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7311         // enforce it at shutdown message
7312
7313         let mut config = UserConfig::default();
7314         config.channel_options.announced_channel = true;
7315         config.peer_channel_config_limits.force_announced_channel_preference = false;
7316         config.channel_options.commit_upfront_shutdown_pubkey = false;
7317         let user_cfgs = [None, Some(config), None];
7318         let chanmon_cfgs = create_chanmon_cfgs(3);
7319         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7320         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7321         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7322
7323         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7324         let flags = InitFeatures::known();
7325         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7326         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7327         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7328         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7329         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7330         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7331     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()));
7332         check_added_monitors!(nodes[2], 1);
7333
7334         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7335         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7336         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7337         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7338         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7339         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7340         let events = nodes[2].node.get_and_clear_pending_msg_events();
7341         assert_eq!(events.len(), 1);
7342         match events[0] {
7343                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7344                 _ => panic!("Unexpected event"),
7345         }
7346
7347         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7348         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7349         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7350         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7351         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7352         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7353         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7354         let events = nodes[1].node.get_and_clear_pending_msg_events();
7355         assert_eq!(events.len(), 1);
7356         match events[0] {
7357                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7358                 _ => panic!("Unexpected event"),
7359         }
7360
7361         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7362         // channel smoothly, opt-out is from channel initiator here
7363         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7364         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7365         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7366         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7367         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7368         let events = nodes[0].node.get_and_clear_pending_msg_events();
7369         assert_eq!(events.len(), 1);
7370         match events[0] {
7371                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7372                 _ => panic!("Unexpected event"),
7373         }
7374
7375         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7376         //// channel smoothly
7377         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7378         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7379         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7380         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7381         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7382         let events = nodes[0].node.get_and_clear_pending_msg_events();
7383         assert_eq!(events.len(), 2);
7384         match events[0] {
7385                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7386                 _ => panic!("Unexpected event"),
7387         }
7388         match events[1] {
7389                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7390                 _ => panic!("Unexpected event"),
7391         }
7392 }
7393
7394 #[test]
7395 fn test_upfront_shutdown_script_unsupport_segwit() {
7396         // We test that channel is closed early
7397         // if a segwit program is passed as upfront shutdown script,
7398         // but the peer does not support segwit.
7399         let chanmon_cfgs = create_chanmon_cfgs(2);
7400         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7401         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7402         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7403
7404         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7405
7406         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7407         open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(16)
7408                 .push_slice(&[0, 0])
7409                 .into_script());
7410
7411         let features = InitFeatures::known().clear_shutdown_anysegwit();
7412         nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), features, &open_channel);
7413
7414         let events = nodes[0].node.get_and_clear_pending_msg_events();
7415         assert_eq!(events.len(), 1);
7416         match events[0] {
7417                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7418                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
7419                         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));
7420                 },
7421                 _ => panic!("Unexpected event"),
7422         }
7423 }
7424
7425 #[test]
7426 fn test_shutdown_script_any_segwit_allowed() {
7427         let mut config = UserConfig::default();
7428         config.channel_options.announced_channel = true;
7429         config.peer_channel_config_limits.force_announced_channel_preference = false;
7430         config.channel_options.commit_upfront_shutdown_pubkey = false;
7431         let user_cfgs = [None, Some(config), None];
7432         let chanmon_cfgs = create_chanmon_cfgs(3);
7433         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7434         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7435         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7436
7437         //// We test if the remote peer accepts opt_shutdown_anysegwit, a witness program can be used on shutdown
7438         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7439         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7440         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7441         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7442                 .push_slice(&[0, 0])
7443                 .into_script();
7444         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7445         let events = nodes[0].node.get_and_clear_pending_msg_events();
7446         assert_eq!(events.len(), 2);
7447         match events[0] {
7448                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7449                 _ => panic!("Unexpected event"),
7450         }
7451         match events[1] {
7452                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7453                 _ => panic!("Unexpected event"),
7454         }
7455 }
7456
7457 #[test]
7458 fn test_shutdown_script_any_segwit_not_allowed() {
7459         let mut config = UserConfig::default();
7460         config.channel_options.announced_channel = true;
7461         config.peer_channel_config_limits.force_announced_channel_preference = false;
7462         config.channel_options.commit_upfront_shutdown_pubkey = false;
7463         let user_cfgs = [None, Some(config), None];
7464         let chanmon_cfgs = create_chanmon_cfgs(3);
7465         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7466         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7467         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7468
7469         //// We test that if the remote peer does not accept opt_shutdown_anysegwit, the witness program cannot be used on shutdown
7470         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7471         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7472         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7473         // Make an any segwit version script
7474         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7475                 .push_slice(&[0, 0])
7476                 .into_script();
7477         let flags_no = InitFeatures::known().clear_shutdown_anysegwit();
7478         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &flags_no, &node_0_shutdown);
7479         let events = nodes[0].node.get_and_clear_pending_msg_events();
7480         assert_eq!(events.len(), 2);
7481         match events[1] {
7482                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7483                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7484                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020000) from remote peer".to_owned())
7485                 },
7486                 _ => panic!("Unexpected event"),
7487         }
7488         check_added_monitors!(nodes[0], 1);
7489 }
7490
7491 #[test]
7492 fn test_shutdown_script_segwit_but_not_anysegwit() {
7493         let mut config = UserConfig::default();
7494         config.channel_options.announced_channel = true;
7495         config.peer_channel_config_limits.force_announced_channel_preference = false;
7496         config.channel_options.commit_upfront_shutdown_pubkey = false;
7497         let user_cfgs = [None, Some(config), None];
7498         let chanmon_cfgs = create_chanmon_cfgs(3);
7499         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7500         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7501         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7502
7503         //// We test that if shutdown any segwit is supported and we send a witness script with 0 version, this is not accepted
7504         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7505         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7506         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7507         // Make a segwit script that is not a valid as any segwit
7508         node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7509                 .push_slice(&[0, 0])
7510                 .into_script();
7511         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7512         let events = nodes[0].node.get_and_clear_pending_msg_events();
7513         assert_eq!(events.len(), 2);
7514         match events[1] {
7515                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7516                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7517                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7518                 },
7519                 _ => panic!("Unexpected event"),
7520         }
7521         check_added_monitors!(nodes[0], 1);
7522 }
7523
7524 #[test]
7525 fn test_user_configurable_csv_delay() {
7526         // We test our channel constructors yield errors when we pass them absurd csv delay
7527
7528         let mut low_our_to_self_config = UserConfig::default();
7529         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7530         let mut high_their_to_self_config = UserConfig::default();
7531         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7532         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7533         let chanmon_cfgs = create_chanmon_cfgs(2);
7534         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7535         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7536         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7537
7538         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7539         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) {
7540                 match error {
7541                         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())); },
7542                         _ => panic!("Unexpected event"),
7543                 }
7544         } else { assert!(false) }
7545
7546         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7547         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7548         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7549         open_channel.to_self_delay = 200;
7550         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) {
7551                 match error {
7552                         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()));  },
7553                         _ => panic!("Unexpected event"),
7554                 }
7555         } else { assert!(false); }
7556
7557         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7558         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7559         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()));
7560         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7561         accept_channel.to_self_delay = 200;
7562         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7563         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7564                 match action {
7565                         &ErrorAction::SendErrorMessage { ref msg } => {
7566                                 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()));
7567                         },
7568                         _ => { assert!(false); }
7569                 }
7570         } else { assert!(false); }
7571
7572         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7573         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7574         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7575         open_channel.to_self_delay = 200;
7576         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) {
7577                 match error {
7578                         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())); },
7579                         _ => panic!("Unexpected event"),
7580                 }
7581         } else { assert!(false); }
7582 }
7583
7584 #[test]
7585 fn test_data_loss_protect() {
7586         // We want to be sure that :
7587         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7588         //   (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7589         // * we close channel in case of detecting other being fallen behind
7590         // * we are able to claim our own outputs thanks to to_remote being static
7591         // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7592         let persister;
7593         let logger;
7594         let fee_estimator;
7595         let tx_broadcaster;
7596         let chain_source;
7597         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7598         // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7599         // during signing due to revoked tx
7600         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7601         let keys_manager = &chanmon_cfgs[0].keys_manager;
7602         let monitor;
7603         let node_state_0;
7604         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7605         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7606         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7607
7608         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7609
7610         // Cache node A state before any channel update
7611         let previous_node_state = nodes[0].node.encode();
7612         let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7613         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7614
7615         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7616         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7617
7618         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7619         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7620
7621         // Restore node A from previous state
7622         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7623         let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7624         chain_source = test_utils::TestChainSource::new(Network::Testnet);
7625         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
7626         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7627         persister = test_utils::TestPersister::new();
7628         monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7629         node_state_0 = {
7630                 let mut channel_monitors = HashMap::new();
7631                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7632                 <(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 {
7633                         keys_manager: keys_manager,
7634                         fee_estimator: &fee_estimator,
7635                         chain_monitor: &monitor,
7636                         logger: &logger,
7637                         tx_broadcaster: &tx_broadcaster,
7638                         default_config: UserConfig::default(),
7639                         channel_monitors,
7640                 }).unwrap().1
7641         };
7642         nodes[0].node = &node_state_0;
7643         assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7644         nodes[0].chain_monitor = &monitor;
7645         nodes[0].chain_source = &chain_source;
7646
7647         check_added_monitors!(nodes[0], 1);
7648
7649         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7650         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7651
7652         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7653
7654         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7655         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7656         check_added_monitors!(nodes[0], 1);
7657
7658         {
7659                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7660                 assert_eq!(node_txn.len(), 0);
7661         }
7662
7663         let mut reestablish_1 = Vec::with_capacity(1);
7664         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7665                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7666                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7667                         reestablish_1.push(msg.clone());
7668                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7669                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7670                         match action {
7671                                 &ErrorAction::SendErrorMessage { ref msg } => {
7672                                         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");
7673                                 },
7674                                 _ => panic!("Unexpected event!"),
7675                         }
7676                 } else {
7677                         panic!("Unexpected event")
7678                 }
7679         }
7680
7681         // Check we close channel detecting A is fallen-behind
7682         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7683         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7684         check_added_monitors!(nodes[1], 1);
7685
7686
7687         // Check A is able to claim to_remote output
7688         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7689         assert_eq!(node_txn.len(), 1);
7690         check_spends!(node_txn[0], chan.3);
7691         assert_eq!(node_txn[0].output.len(), 2);
7692         mine_transaction(&nodes[0], &node_txn[0]);
7693         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7694         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 1000000);
7695         assert_eq!(spend_txn.len(), 1);
7696         check_spends!(spend_txn[0], node_txn[0]);
7697 }
7698
7699 #[test]
7700 fn test_check_htlc_underpaying() {
7701         // Send payment through A -> B but A is maliciously
7702         // sending a probe payment (i.e less than expected value0
7703         // to B, B should refuse payment.
7704
7705         let chanmon_cfgs = create_chanmon_cfgs(2);
7706         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7707         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7708         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7709
7710         // Create some initial channels
7711         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7712
7713         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();
7714         let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7715         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7716         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7717         check_added_monitors!(nodes[0], 1);
7718
7719         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7720         assert_eq!(events.len(), 1);
7721         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7722         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7723         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7724
7725         // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7726         // and then will wait a second random delay before failing the HTLC back:
7727         expect_pending_htlcs_forwardable!(nodes[1]);
7728         expect_pending_htlcs_forwardable!(nodes[1]);
7729
7730         // Node 3 is expecting payment of 100_000 but received 10_000,
7731         // it should fail htlc like we didn't know the preimage.
7732         nodes[1].node.process_pending_htlc_forwards();
7733
7734         let events = nodes[1].node.get_and_clear_pending_msg_events();
7735         assert_eq!(events.len(), 1);
7736         let (update_fail_htlc, commitment_signed) = match events[0] {
7737                 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 } } => {
7738                         assert!(update_add_htlcs.is_empty());
7739                         assert!(update_fulfill_htlcs.is_empty());
7740                         assert_eq!(update_fail_htlcs.len(), 1);
7741                         assert!(update_fail_malformed_htlcs.is_empty());
7742                         assert!(update_fee.is_none());
7743                         (update_fail_htlcs[0].clone(), commitment_signed)
7744                 },
7745                 _ => panic!("Unexpected event"),
7746         };
7747         check_added_monitors!(nodes[1], 1);
7748
7749         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7750         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7751
7752         // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7753         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7754         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7755         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7756 }
7757
7758 #[test]
7759 fn test_announce_disable_channels() {
7760         // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7761         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7762
7763         let chanmon_cfgs = create_chanmon_cfgs(2);
7764         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7765         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7766         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7767
7768         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7769         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7770         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7771
7772         // Disconnect peers
7773         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7774         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7775
7776         nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7777         nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7778         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7779         assert_eq!(msg_events.len(), 3);
7780         let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7781         for e in msg_events {
7782                 match e {
7783                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7784                                 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7785                                 // Check that each channel gets updated exactly once
7786                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7787                                         panic!("Generated ChannelUpdate for wrong chan!");
7788                                 }
7789                         },
7790                         _ => panic!("Unexpected event"),
7791                 }
7792         }
7793         // Reconnect peers
7794         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7795         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7796         assert_eq!(reestablish_1.len(), 3);
7797         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7798         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7799         assert_eq!(reestablish_2.len(), 3);
7800
7801         // Reestablish chan_1
7802         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7803         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7804         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7805         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7806         // Reestablish chan_2
7807         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7808         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7809         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7810         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7811         // Reestablish chan_3
7812         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7813         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7814         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7815         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7816
7817         nodes[0].node.timer_tick_occurred();
7818         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7819         nodes[0].node.timer_tick_occurred();
7820         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7821         assert_eq!(msg_events.len(), 3);
7822         chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7823         for e in msg_events {
7824                 match e {
7825                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7826                                 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7827                                 // Check that each channel gets updated exactly once
7828                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7829                                         panic!("Generated ChannelUpdate for wrong chan!");
7830                                 }
7831                         },
7832                         _ => panic!("Unexpected event"),
7833                 }
7834         }
7835 }
7836
7837 #[test]
7838 fn test_bump_penalty_txn_on_revoked_commitment() {
7839         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7840         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7841
7842         let chanmon_cfgs = create_chanmon_cfgs(2);
7843         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7844         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7845         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7846
7847         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7848         let logger = test_utils::TestLogger::new();
7849
7850         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7851         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7852         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();
7853         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7854
7855         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7856         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7857         assert_eq!(revoked_txn[0].output.len(), 4);
7858         assert_eq!(revoked_txn[0].input.len(), 1);
7859         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7860         let revoked_txid = revoked_txn[0].txid();
7861
7862         let mut penalty_sum = 0;
7863         for outp in revoked_txn[0].output.iter() {
7864                 if outp.script_pubkey.is_v0_p2wsh() {
7865                         penalty_sum += outp.value;
7866                 }
7867         }
7868
7869         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7870         let header_114 = connect_blocks(&nodes[1], 14);
7871
7872         // Actually revoke tx by claiming a HTLC
7873         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7874         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7875         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7876         check_added_monitors!(nodes[1], 1);
7877
7878         // One or more justice tx should have been broadcast, check it
7879         let penalty_1;
7880         let feerate_1;
7881         {
7882                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7883                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7884                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7885                 assert_eq!(node_txn[0].output.len(), 1);
7886                 check_spends!(node_txn[0], revoked_txn[0]);
7887                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7888                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7889                 penalty_1 = node_txn[0].txid();
7890                 node_txn.clear();
7891         };
7892
7893         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7894         connect_blocks(&nodes[1], 15);
7895         let mut penalty_2 = penalty_1;
7896         let mut feerate_2 = 0;
7897         {
7898                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7899                 assert_eq!(node_txn.len(), 1);
7900                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7901                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7902                         assert_eq!(node_txn[0].output.len(), 1);
7903                         check_spends!(node_txn[0], revoked_txn[0]);
7904                         penalty_2 = node_txn[0].txid();
7905                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7906                         assert_ne!(penalty_2, penalty_1);
7907                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7908                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7909                         // Verify 25% bump heuristic
7910                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7911                         node_txn.clear();
7912                 }
7913         }
7914         assert_ne!(feerate_2, 0);
7915
7916         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7917         connect_blocks(&nodes[1], 1);
7918         let penalty_3;
7919         let mut feerate_3 = 0;
7920         {
7921                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7922                 assert_eq!(node_txn.len(), 1);
7923                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7924                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7925                         assert_eq!(node_txn[0].output.len(), 1);
7926                         check_spends!(node_txn[0], revoked_txn[0]);
7927                         penalty_3 = node_txn[0].txid();
7928                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7929                         assert_ne!(penalty_3, penalty_2);
7930                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7931                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7932                         // Verify 25% bump heuristic
7933                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7934                         node_txn.clear();
7935                 }
7936         }
7937         assert_ne!(feerate_3, 0);
7938
7939         nodes[1].node.get_and_clear_pending_events();
7940         nodes[1].node.get_and_clear_pending_msg_events();
7941 }
7942
7943 #[test]
7944 fn test_bump_penalty_txn_on_revoked_htlcs() {
7945         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7946         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7947
7948         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7949         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
7950         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7951         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7952         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7953
7954         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7955         // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
7956         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
7957                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
7958         let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
7959         let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph.read().unwrap(),
7960                 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
7961         send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
7962
7963         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7964         assert_eq!(revoked_local_txn[0].input.len(), 1);
7965         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7966
7967         // Revoke local commitment tx
7968         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7969
7970         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7971         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7972         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
7973         check_closed_broadcast!(nodes[1], true);
7974         check_added_monitors!(nodes[1], 1);
7975
7976         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7977         assert_eq!(revoked_htlc_txn.len(), 4);
7978         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7979                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7980                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7981                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7982                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7983                 assert_eq!(revoked_htlc_txn[1].output.len(), 1);
7984                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7985         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7986                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7987                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7988                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7989                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7990                 assert_eq!(revoked_htlc_txn[0].output.len(), 1);
7991                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7992         }
7993
7994         // Broadcast set of revoked txn on A
7995         let hash_128 = connect_blocks(&nodes[0], 40);
7996         let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7997         connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
7998         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7999         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] });
8000         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8001         let first;
8002         let feerate_1;
8003         let penalty_txn;
8004         {
8005                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8006                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
8007                 // Verify claim tx are spending revoked HTLC txn
8008
8009                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
8010                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
8011                 // which are included in the same block (they are broadcasted because we scan the
8012                 // transactions linearly and generate claims as we go, they likely should be removed in the
8013                 // future).
8014                 assert_eq!(node_txn[0].input.len(), 1);
8015                 check_spends!(node_txn[0], revoked_local_txn[0]);
8016                 assert_eq!(node_txn[1].input.len(), 1);
8017                 check_spends!(node_txn[1], revoked_local_txn[0]);
8018                 assert_eq!(node_txn[2].input.len(), 1);
8019                 check_spends!(node_txn[2], revoked_local_txn[0]);
8020
8021                 // Each of the three justice transactions claim a separate (single) output of the three
8022                 // available, which we check here:
8023                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
8024                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
8025                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
8026
8027                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8028                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
8029
8030                 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
8031                 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
8032                 // a remote commitment tx has already been confirmed).
8033                 check_spends!(node_txn[3], chan.3);
8034
8035                 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
8036                 // output, checked above).
8037                 assert_eq!(node_txn[4].input.len(), 2);
8038                 assert_eq!(node_txn[4].output.len(), 1);
8039                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
8040
8041                 first = node_txn[4].txid();
8042                 // Store both feerates for later comparison
8043                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
8044                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
8045                 penalty_txn = vec![node_txn[2].clone()];
8046                 node_txn.clear();
8047         }
8048
8049         // Connect one more block to see if bumped penalty are issued for HTLC txn
8050         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8051         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8052         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8053         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
8054         {
8055                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8056                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
8057
8058                 check_spends!(node_txn[0], revoked_local_txn[0]);
8059                 check_spends!(node_txn[1], revoked_local_txn[0]);
8060                 // Note that these are both bogus - they spend outputs already claimed in block 129:
8061                 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output  {
8062                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
8063                 } else {
8064                         assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
8065                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8066                 }
8067
8068                 node_txn.clear();
8069         };
8070
8071         // Few more blocks to confirm penalty txn
8072         connect_blocks(&nodes[0], 4);
8073         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8074         let header_144 = connect_blocks(&nodes[0], 9);
8075         let node_txn = {
8076                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8077                 assert_eq!(node_txn.len(), 1);
8078
8079                 assert_eq!(node_txn[0].input.len(), 2);
8080                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
8081                 // Verify bumped tx is different and 25% bump heuristic
8082                 assert_ne!(first, node_txn[0].txid());
8083                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
8084                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8085                 assert!(feerate_2 * 100 > feerate_1 * 125);
8086                 let txn = vec![node_txn[0].clone()];
8087                 node_txn.clear();
8088                 txn
8089         };
8090         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8091         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8092         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
8093         connect_blocks(&nodes[0], 20);
8094         {
8095                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8096                 // We verify than no new transaction has been broadcast because previously
8097                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8098                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8099                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8100                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8101                 // up bumped justice generation.
8102                 assert_eq!(node_txn.len(), 0);
8103                 node_txn.clear();
8104         }
8105         check_closed_broadcast!(nodes[0], true);
8106         check_added_monitors!(nodes[0], 1);
8107 }
8108
8109 #[test]
8110 fn test_bump_penalty_txn_on_remote_commitment() {
8111         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8112         // we're able to claim outputs on remote commitment transaction before timelocks expiration
8113
8114         // Create 2 HTLCs
8115         // Provide preimage for one
8116         // Check aggregation
8117
8118         let chanmon_cfgs = create_chanmon_cfgs(2);
8119         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8120         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8121         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8122
8123         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8124         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8125         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8126
8127         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8128         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8129         assert_eq!(remote_txn[0].output.len(), 4);
8130         assert_eq!(remote_txn[0].input.len(), 1);
8131         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8132
8133         // Claim a HTLC without revocation (provide B monitor with preimage)
8134         nodes[1].node.claim_funds(payment_preimage);
8135         mine_transaction(&nodes[1], &remote_txn[0]);
8136         check_added_monitors!(nodes[1], 2);
8137
8138         // One or more claim tx should have been broadcast, check it
8139         let timeout;
8140         let preimage;
8141         let feerate_timeout;
8142         let feerate_preimage;
8143         {
8144                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8145                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
8146                 assert_eq!(node_txn[0].input.len(), 1);
8147                 assert_eq!(node_txn[1].input.len(), 1);
8148                 check_spends!(node_txn[0], remote_txn[0]);
8149                 check_spends!(node_txn[1], remote_txn[0]);
8150                 check_spends!(node_txn[2], chan.3);
8151                 check_spends!(node_txn[3], node_txn[2]);
8152                 check_spends!(node_txn[4], node_txn[2]);
8153                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8154                         timeout = node_txn[0].txid();
8155                         let index = node_txn[0].input[0].previous_output.vout;
8156                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8157                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
8158
8159                         preimage = node_txn[1].txid();
8160                         let index = node_txn[1].input[0].previous_output.vout;
8161                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8162                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
8163                 } else {
8164                         timeout = node_txn[1].txid();
8165                         let index = node_txn[1].input[0].previous_output.vout;
8166                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8167                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
8168
8169                         preimage = node_txn[0].txid();
8170                         let index = node_txn[0].input[0].previous_output.vout;
8171                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8172                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8173                 }
8174                 node_txn.clear();
8175         };
8176         assert_ne!(feerate_timeout, 0);
8177         assert_ne!(feerate_preimage, 0);
8178
8179         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8180         connect_blocks(&nodes[1], 15);
8181         {
8182                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8183                 assert_eq!(node_txn.len(), 2);
8184                 assert_eq!(node_txn[0].input.len(), 1);
8185                 assert_eq!(node_txn[1].input.len(), 1);
8186                 check_spends!(node_txn[0], remote_txn[0]);
8187                 check_spends!(node_txn[1], remote_txn[0]);
8188                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8189                         let index = node_txn[0].input[0].previous_output.vout;
8190                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8191                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8192                         assert!(new_feerate * 100 > feerate_timeout * 125);
8193                         assert_ne!(timeout, node_txn[0].txid());
8194
8195                         let index = node_txn[1].input[0].previous_output.vout;
8196                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8197                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8198                         assert!(new_feerate * 100 > feerate_preimage * 125);
8199                         assert_ne!(preimage, node_txn[1].txid());
8200                 } else {
8201                         let index = node_txn[1].input[0].previous_output.vout;
8202                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8203                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8204                         assert!(new_feerate * 100 > feerate_timeout * 125);
8205                         assert_ne!(timeout, node_txn[1].txid());
8206
8207                         let index = node_txn[0].input[0].previous_output.vout;
8208                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8209                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8210                         assert!(new_feerate * 100 > feerate_preimage * 125);
8211                         assert_ne!(preimage, node_txn[0].txid());
8212                 }
8213                 node_txn.clear();
8214         }
8215
8216         nodes[1].node.get_and_clear_pending_events();
8217         nodes[1].node.get_and_clear_pending_msg_events();
8218 }
8219
8220 #[test]
8221 fn test_counterparty_raa_skip_no_crash() {
8222         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8223         // commitment transaction, we would have happily carried on and provided them the next
8224         // commitment transaction based on one RAA forward. This would probably eventually have led to
8225         // channel closure, but it would not have resulted in funds loss. Still, our
8226         // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
8227         // check simply that the channel is closed in response to such an RAA, but don't check whether
8228         // we decide to punish our counterparty for revoking their funds (as we don't currently
8229         // implement that).
8230         let chanmon_cfgs = create_chanmon_cfgs(2);
8231         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8232         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8233         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8234         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8235
8236         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8237         let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8238         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8239         let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8240         // Must revoke without gaps
8241         keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8242         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8243                 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8244
8245         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8246                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8247         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8248         check_added_monitors!(nodes[1], 1);
8249 }
8250
8251 #[test]
8252 fn test_bump_txn_sanitize_tracking_maps() {
8253         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8254         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8255
8256         let chanmon_cfgs = create_chanmon_cfgs(2);
8257         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8258         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8259         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8260
8261         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8262         // Lock HTLC in both directions
8263         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8264         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8265
8266         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8267         assert_eq!(revoked_local_txn[0].input.len(), 1);
8268         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8269
8270         // Revoke local commitment tx
8271         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8272
8273         // Broadcast set of revoked txn on A
8274         connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8275         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8276         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8277
8278         mine_transaction(&nodes[0], &revoked_local_txn[0]);
8279         check_closed_broadcast!(nodes[0], true);
8280         check_added_monitors!(nodes[0], 1);
8281         let penalty_txn = {
8282                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8283                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8284                 check_spends!(node_txn[0], revoked_local_txn[0]);
8285                 check_spends!(node_txn[1], revoked_local_txn[0]);
8286                 check_spends!(node_txn[2], revoked_local_txn[0]);
8287                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8288                 node_txn.clear();
8289                 penalty_txn
8290         };
8291         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8292         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8293         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8294         {
8295                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8296                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8297                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8298                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8299                 }
8300         }
8301 }
8302
8303 #[test]
8304 fn test_override_channel_config() {
8305         let chanmon_cfgs = create_chanmon_cfgs(2);
8306         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8307         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8308         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8309
8310         // Node0 initiates a channel to node1 using the override config.
8311         let mut override_config = UserConfig::default();
8312         override_config.own_channel_config.our_to_self_delay = 200;
8313
8314         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8315
8316         // Assert the channel created by node0 is using the override config.
8317         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8318         assert_eq!(res.channel_flags, 0);
8319         assert_eq!(res.to_self_delay, 200);
8320 }
8321
8322 #[test]
8323 fn test_override_0msat_htlc_minimum() {
8324         let mut zero_config = UserConfig::default();
8325         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8326         let chanmon_cfgs = create_chanmon_cfgs(2);
8327         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8328         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8329         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8330
8331         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8332         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8333         assert_eq!(res.htlc_minimum_msat, 1);
8334
8335         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8336         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8337         assert_eq!(res.htlc_minimum_msat, 1);
8338 }
8339
8340 #[test]
8341 fn test_simple_mpp() {
8342         // Simple test of sending a multi-path payment.
8343         let chanmon_cfgs = create_chanmon_cfgs(4);
8344         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8345         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8346         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8347
8348         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8349         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8350         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8351         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8352         let logger = test_utils::TestLogger::new();
8353
8354         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8355         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8356         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();
8357         let path = route.paths[0].clone();
8358         route.paths.push(path);
8359         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8360         route.paths[0][0].short_channel_id = chan_1_id;
8361         route.paths[0][1].short_channel_id = chan_3_id;
8362         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8363         route.paths[1][0].short_channel_id = chan_2_id;
8364         route.paths[1][1].short_channel_id = chan_4_id;
8365         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8366         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8367 }
8368
8369 #[test]
8370 fn test_preimage_storage() {
8371         // Simple test of payment preimage storage allowing no client-side storage to claim payments
8372         let chanmon_cfgs = create_chanmon_cfgs(2);
8373         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8374         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8375         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8376
8377         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8378
8379         {
8380                 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8381
8382                 let logger = test_utils::TestLogger::new();
8383                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8384                 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();
8385                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8386                 check_added_monitors!(nodes[0], 1);
8387                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8388                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8389                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8390                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8391         }
8392         // Note that after leaving the above scope we have no knowledge of any arguments or return
8393         // values from previous calls.
8394         expect_pending_htlcs_forwardable!(nodes[1]);
8395         let events = nodes[1].node.get_and_clear_pending_events();
8396         assert_eq!(events.len(), 1);
8397         match events[0] {
8398                 Event::PaymentReceived { payment_preimage, user_payment_id, .. } => {
8399                         assert_eq!(user_payment_id, 42);
8400                         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8401                 },
8402                 _ => panic!("Unexpected event"),
8403         }
8404 }
8405
8406 #[test]
8407 fn test_secret_timeout() {
8408         // Simple test of payment secret storage time outs
8409         let chanmon_cfgs = create_chanmon_cfgs(2);
8410         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8411         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8412         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8413
8414         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8415
8416         let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8417
8418         // We should fail to register the same payment hash twice, at least until we've connected a
8419         // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8420         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8421                 assert_eq!(err, "Duplicate payment hash");
8422         } else { panic!(); }
8423         let mut block = Block {
8424                 header: BlockHeader {
8425                         version: 0x2000000,
8426                         prev_blockhash: nodes[1].blocks.borrow().last().unwrap().0.block_hash(),
8427                         merkle_root: Default::default(),
8428                         time: nodes[1].blocks.borrow().len() as u32 + 7200, bits: 42, nonce: 42 },
8429                 txdata: vec![],
8430         };
8431         connect_block(&nodes[1], &block);
8432         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8433                 assert_eq!(err, "Duplicate payment hash");
8434         } else { panic!(); }
8435
8436         // If we then connect the second block, we should be able to register the same payment hash
8437         // again with a different user_payment_id (this time getting a new payment secret).
8438         block.header.prev_blockhash = block.header.block_hash();
8439         block.header.time += 1;
8440         connect_block(&nodes[1], &block);
8441         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8442         assert_ne!(payment_secret_1, our_payment_secret);
8443
8444         {
8445                 let logger = test_utils::TestLogger::new();
8446                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8447                 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();
8448                 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8449                 check_added_monitors!(nodes[0], 1);
8450                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8451                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8452                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8453                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8454         }
8455         // Note that after leaving the above scope we have no knowledge of any arguments or return
8456         // values from previous calls.
8457         expect_pending_htlcs_forwardable!(nodes[1]);
8458         let events = nodes[1].node.get_and_clear_pending_events();
8459         assert_eq!(events.len(), 1);
8460         match events[0] {
8461                 Event::PaymentReceived { payment_preimage, payment_secret, user_payment_id, .. } => {
8462                         assert!(payment_preimage.is_none());
8463                         assert_eq!(user_payment_id, 42);
8464                         assert_eq!(payment_secret, our_payment_secret);
8465                         // We don't actually have the payment preimage with which to claim this payment!
8466                 },
8467                 _ => panic!("Unexpected event"),
8468         }
8469 }
8470
8471 #[test]
8472 fn test_bad_secret_hash() {
8473         // Simple test of unregistered payment hash/invalid payment secret handling
8474         let chanmon_cfgs = create_chanmon_cfgs(2);
8475         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8476         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8477         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8478
8479         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8480
8481         let random_payment_hash = PaymentHash([42; 32]);
8482         let random_payment_secret = PaymentSecret([43; 32]);
8483         let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8484
8485         let logger = test_utils::TestLogger::new();
8486         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8487         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();
8488
8489         // All the below cases should end up being handled exactly identically, so we macro the
8490         // resulting events.
8491         macro_rules! handle_unknown_invalid_payment_data {
8492                 () => {
8493                         check_added_monitors!(nodes[0], 1);
8494                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8495                         let payment_event = SendEvent::from_event(events.pop().unwrap());
8496                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8497                         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8498
8499                         // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8500                         // again to process the pending backwards-failure of the HTLC
8501                         expect_pending_htlcs_forwardable!(nodes[1]);
8502                         expect_pending_htlcs_forwardable!(nodes[1]);
8503                         check_added_monitors!(nodes[1], 1);
8504
8505                         // We should fail the payment back
8506                         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8507                         match events.pop().unwrap() {
8508                                 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8509                                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8510                                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8511                                 },
8512                                 _ => panic!("Unexpected event"),
8513                         }
8514                 }
8515         }
8516
8517         let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8518         // Error data is the HTLC value (100,000) and current block height
8519         let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8520
8521         // Send a payment with the right payment hash but the wrong payment secret
8522         nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8523         handle_unknown_invalid_payment_data!();
8524         expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8525
8526         // Send a payment with a random payment hash, but the right payment secret
8527         nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8528         handle_unknown_invalid_payment_data!();
8529         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8530
8531         // Send a payment with a random payment hash and random payment secret
8532         nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8533         handle_unknown_invalid_payment_data!();
8534         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8535 }
8536
8537 #[test]
8538 fn test_update_err_monitor_lockdown() {
8539         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8540         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8541         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8542         //
8543         // This scenario may happen in a watchtower setup, where watchtower process a block height
8544         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8545         // commitment at same time.
8546
8547         let chanmon_cfgs = create_chanmon_cfgs(2);
8548         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8549         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8550         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8551
8552         // Create some initial channel
8553         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8554         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8555
8556         // Rebalance the network to generate htlc in the two directions
8557         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8558
8559         // Route a HTLC from node 0 to node 1 (but don't settle)
8560         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8561
8562         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8563         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8564         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8565         let persister = test_utils::TestPersister::new();
8566         let watchtower = {
8567                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8568                 let monitor = monitors.get(&outpoint).unwrap();
8569                 let mut w = test_utils::TestVecWriter(Vec::new());
8570                 monitor.write(&mut w).unwrap();
8571                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8572                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8573                 assert!(new_monitor == *monitor);
8574                 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);
8575                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8576                 watchtower
8577         };
8578         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8579         watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8580
8581         // Try to update ChannelMonitor
8582         assert!(nodes[1].node.claim_funds(preimage));
8583         check_added_monitors!(nodes[1], 1);
8584         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8585         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8586         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8587         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8588                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8589                         if let Err(_) =  watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8590                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8591                 } else { assert!(false); }
8592         } else { assert!(false); };
8593         // Our local monitor is in-sync and hasn't processed yet timeout
8594         check_added_monitors!(nodes[0], 1);
8595         let events = nodes[0].node.get_and_clear_pending_events();
8596         assert_eq!(events.len(), 1);
8597 }
8598
8599 #[test]
8600 fn test_concurrent_monitor_claim() {
8601         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8602         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8603         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8604         // state N+1 confirms. Alice claims output from state N+1.
8605
8606         let chanmon_cfgs = create_chanmon_cfgs(2);
8607         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8608         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8609         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8610
8611         // Create some initial channel
8612         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8613         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8614
8615         // Rebalance the network to generate htlc in the two directions
8616         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8617
8618         // Route a HTLC from node 0 to node 1 (but don't settle)
8619         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8620
8621         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8622         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8623         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8624         let persister = test_utils::TestPersister::new();
8625         let watchtower_alice = {
8626                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8627                 let monitor = monitors.get(&outpoint).unwrap();
8628                 let mut w = test_utils::TestVecWriter(Vec::new());
8629                 monitor.write(&mut w).unwrap();
8630                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8631                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8632                 assert!(new_monitor == *monitor);
8633                 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);
8634                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8635                 watchtower
8636         };
8637         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8638         watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8639
8640         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8641         {
8642                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8643                 assert_eq!(txn.len(), 2);
8644                 txn.clear();
8645         }
8646
8647         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8648         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8649         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8650         let persister = test_utils::TestPersister::new();
8651         let watchtower_bob = {
8652                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8653                 let monitor = monitors.get(&outpoint).unwrap();
8654                 let mut w = test_utils::TestVecWriter(Vec::new());
8655                 monitor.write(&mut w).unwrap();
8656                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8657                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8658                 assert!(new_monitor == *monitor);
8659                 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);
8660                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8661                 watchtower
8662         };
8663         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8664         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8665
8666         // Route another payment to generate another update with still previous HTLC pending
8667         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8668         {
8669                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8670                 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();
8671                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8672         }
8673         check_added_monitors!(nodes[1], 1);
8674
8675         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8676         assert_eq!(updates.update_add_htlcs.len(), 1);
8677         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8678         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8679                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8680                         // Watchtower Alice should already have seen the block and reject the update
8681                         if let Err(_) =  watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8682                         if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8683                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8684                 } else { assert!(false); }
8685         } else { assert!(false); };
8686         // Our local monitor is in-sync and hasn't processed yet timeout
8687         check_added_monitors!(nodes[0], 1);
8688
8689         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8690         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8691         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8692
8693         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8694         let bob_state_y;
8695         {
8696                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8697                 assert_eq!(txn.len(), 2);
8698                 bob_state_y = txn[0].clone();
8699                 txn.clear();
8700         };
8701
8702         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8703         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8704         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);
8705         {
8706                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8707                 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8708                 // the onchain detection of the HTLC output
8709                 assert_eq!(htlc_txn.len(), 2);
8710                 check_spends!(htlc_txn[0], bob_state_y);
8711                 check_spends!(htlc_txn[1], bob_state_y);
8712         }
8713 }
8714
8715 #[test]
8716 fn test_pre_lockin_no_chan_closed_update() {
8717         // Test that if a peer closes a channel in response to a funding_created message we don't
8718         // generate a channel update (as the channel cannot appear on chain without a funding_signed
8719         // message).
8720         //
8721         // Doing so would imply a channel monitor update before the initial channel monitor
8722         // registration, violating our API guarantees.
8723         //
8724         // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8725         // then opening a second channel with the same funding output as the first (which is not
8726         // rejected because the first channel does not exist in the ChannelManager) and closing it
8727         // before receiving funding_signed.
8728         let chanmon_cfgs = create_chanmon_cfgs(2);
8729         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8730         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8731         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8732
8733         // Create an initial channel
8734         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8735         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8736         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8737         let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8738         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8739
8740         // Move the first channel through the funding flow...
8741         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8742
8743         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8744         check_added_monitors!(nodes[0], 0);
8745
8746         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8747         let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8748         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8749         assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8750 }
8751
8752 #[test]
8753 fn test_htlc_no_detection() {
8754         // This test is a mutation to underscore the detection logic bug we had
8755         // before #653. HTLC value routed is above the remaining balance, thus
8756         // inverting HTLC and `to_remote` output. HTLC will come second and
8757         // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8758         // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8759         // outputs order detection for correct spending children filtring.
8760
8761         let chanmon_cfgs = create_chanmon_cfgs(2);
8762         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8763         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8764         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8765
8766         // Create some initial channels
8767         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8768
8769         send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8770         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8771         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8772         assert_eq!(local_txn[0].input.len(), 1);
8773         assert_eq!(local_txn[0].output.len(), 3);
8774         check_spends!(local_txn[0], chan_1.3);
8775
8776         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8777         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8778         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8779         // We deliberately connect the local tx twice as this should provoke a failure calling
8780         // this test before #653 fix.
8781         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);
8782         check_closed_broadcast!(nodes[0], true);
8783         check_added_monitors!(nodes[0], 1);
8784
8785         let htlc_timeout = {
8786                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8787                 assert_eq!(node_txn[0].input.len(), 1);
8788                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8789                 check_spends!(node_txn[0], local_txn[0]);
8790                 node_txn[0].clone()
8791         };
8792
8793         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8794         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8795         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8796         expect_payment_failed!(nodes[0], our_payment_hash, true);
8797 }
8798
8799 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8800         // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8801         // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8802         // Carol, Alice would be the upstream node, and Carol the downstream.)
8803         //
8804         // Steps of the test:
8805         // 1) Alice sends a HTLC to Carol through Bob.
8806         // 2) Carol doesn't settle the HTLC.
8807         // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8808         // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8809         // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8810         //    but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8811         // 5) Carol release the preimage to Bob off-chain.
8812         // 6) Bob claims the offered output on the broadcasted commitment.
8813         let chanmon_cfgs = create_chanmon_cfgs(3);
8814         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8815         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8816         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8817
8818         // Create some initial channels
8819         let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8820         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8821
8822         // Steps (1) and (2):
8823         // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8824         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8825
8826         // Check that Alice's commitment transaction now contains an output for this HTLC.
8827         let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8828         check_spends!(alice_txn[0], chan_ab.3);
8829         assert_eq!(alice_txn[0].output.len(), 2);
8830         check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8831         assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8832         assert_eq!(alice_txn.len(), 2);
8833
8834         // Steps (3) and (4):
8835         // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8836         // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8837         let mut force_closing_node = 0; // Alice force-closes
8838         if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8839         nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8840         check_closed_broadcast!(nodes[force_closing_node], true);
8841         check_added_monitors!(nodes[force_closing_node], 1);
8842         if go_onchain_before_fulfill {
8843                 let txn_to_broadcast = match broadcast_alice {
8844                         true => alice_txn.clone(),
8845                         false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8846                 };
8847                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8848                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8849                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8850                 if broadcast_alice {
8851                         check_closed_broadcast!(nodes[1], true);
8852                         check_added_monitors!(nodes[1], 1);
8853                 }
8854                 assert_eq!(bob_txn.len(), 1);
8855                 check_spends!(bob_txn[0], chan_ab.3);
8856         }
8857
8858         // Step (5):
8859         // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8860         // process of removing the HTLC from their commitment transactions.
8861         assert!(nodes[2].node.claim_funds(payment_preimage));
8862         check_added_monitors!(nodes[2], 1);
8863         let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8864         assert!(carol_updates.update_add_htlcs.is_empty());
8865         assert!(carol_updates.update_fail_htlcs.is_empty());
8866         assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8867         assert!(carol_updates.update_fee.is_none());
8868         assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8869
8870         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8871         // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8872         if !go_onchain_before_fulfill && broadcast_alice {
8873                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8874                 assert_eq!(events.len(), 1);
8875                 match events[0] {
8876                         MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8877                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8878                         },
8879                         _ => panic!("Unexpected event"),
8880                 };
8881         }
8882         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8883         // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8884         // Carol<->Bob's updated commitment transaction info.
8885         check_added_monitors!(nodes[1], 2);
8886
8887         let events = nodes[1].node.get_and_clear_pending_msg_events();
8888         assert_eq!(events.len(), 2);
8889         let bob_revocation = match events[0] {
8890                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8891                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8892                         (*msg).clone()
8893                 },
8894                 _ => panic!("Unexpected event"),
8895         };
8896         let bob_updates = match events[1] {
8897                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8898                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8899                         (*updates).clone()
8900                 },
8901                 _ => panic!("Unexpected event"),
8902         };
8903
8904         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8905         check_added_monitors!(nodes[2], 1);
8906         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8907         check_added_monitors!(nodes[2], 1);
8908
8909         let events = nodes[2].node.get_and_clear_pending_msg_events();
8910         assert_eq!(events.len(), 1);
8911         let carol_revocation = match events[0] {
8912                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8913                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8914                         (*msg).clone()
8915                 },
8916                 _ => panic!("Unexpected event"),
8917         };
8918         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8919         check_added_monitors!(nodes[1], 1);
8920
8921         // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8922         // here's where we put said channel's commitment tx on-chain.
8923         let mut txn_to_broadcast = alice_txn.clone();
8924         if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8925         if !go_onchain_before_fulfill {
8926                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8927                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8928                 // If Bob was the one to force-close, he will have already passed these checks earlier.
8929                 if broadcast_alice {
8930                         check_closed_broadcast!(nodes[1], true);
8931                         check_added_monitors!(nodes[1], 1);
8932                 }
8933                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8934                 if broadcast_alice {
8935                         // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8936                         // new block being connected. The ChannelManager being notified triggers a monitor update,
8937                         // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8938                         // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8939                         // broadcasted.
8940                         assert_eq!(bob_txn.len(), 3);
8941                         check_spends!(bob_txn[1], chan_ab.3);
8942                 } else {
8943                         assert_eq!(bob_txn.len(), 2);
8944                         check_spends!(bob_txn[0], chan_ab.3);
8945                 }
8946         }
8947
8948         // Step (6):
8949         // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8950         // broadcasted commitment transaction.
8951         {
8952                 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8953                 if go_onchain_before_fulfill {
8954                         // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
8955                         assert_eq!(bob_txn.len(), 2);
8956                 }
8957                 let script_weight = match broadcast_alice {
8958                         true => OFFERED_HTLC_SCRIPT_WEIGHT,
8959                         false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8960                 };
8961                 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
8962                 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
8963                 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
8964                 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
8965                 if broadcast_alice && !go_onchain_before_fulfill {
8966                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
8967                         assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
8968                 } else {
8969                         check_spends!(bob_txn[1], txn_to_broadcast[0]);
8970                         assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
8971                 }
8972         }
8973 }
8974
8975 #[test]
8976 fn test_onchain_htlc_settlement_after_close() {
8977         do_test_onchain_htlc_settlement_after_close(true, true);
8978         do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
8979         do_test_onchain_htlc_settlement_after_close(true, false);
8980         do_test_onchain_htlc_settlement_after_close(false, false);
8981 }
8982
8983 #[test]
8984 fn test_duplicate_chan_id() {
8985         // Test that if a given peer tries to open a channel with the same channel_id as one that is
8986         // already open we reject it and keep the old channel.
8987         //
8988         // Previously, full_stack_target managed to figure out that if you tried to open two channels
8989         // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
8990         // the existing channel when we detect the duplicate new channel, screwing up our monitor
8991         // updating logic for the existing channel.
8992         let chanmon_cfgs = create_chanmon_cfgs(2);
8993         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8994         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8995         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8996
8997         // Create an initial channel
8998         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8999         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9000         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9001         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()));
9002
9003         // Try to create a second channel with the same temporary_channel_id as the first and check
9004         // that it is rejected.
9005         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9006         {
9007                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9008                 assert_eq!(events.len(), 1);
9009                 match events[0] {
9010                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9011                                 // Technically, at this point, nodes[1] would be justified in thinking both the
9012                                 // first (valid) and second (invalid) channels are closed, given they both have
9013                                 // the same non-temporary channel_id. However, currently we do not, so we just
9014                                 // move forward with it.
9015                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9016                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9017                         },
9018                         _ => panic!("Unexpected event"),
9019                 }
9020         }
9021
9022         // Move the first channel through the funding flow...
9023         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
9024
9025         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9026         check_added_monitors!(nodes[0], 0);
9027
9028         let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9029         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9030         {
9031                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9032                 assert_eq!(added_monitors.len(), 1);
9033                 assert_eq!(added_monitors[0].0, funding_output);
9034                 added_monitors.clear();
9035         }
9036         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9037
9038         let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
9039         let channel_id = funding_outpoint.to_channel_id();
9040
9041         // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
9042         // temporary one).
9043
9044         // First try to open a second channel with a temporary channel id equal to the txid-based one.
9045         // Technically this is allowed by the spec, but we don't support it and there's little reason
9046         // to. Still, it shouldn't cause any other issues.
9047         open_chan_msg.temporary_channel_id = channel_id;
9048         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9049         {
9050                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9051                 assert_eq!(events.len(), 1);
9052                 match events[0] {
9053                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9054                                 // Technically, at this point, nodes[1] would be justified in thinking both
9055                                 // channels are closed, but currently we do not, so we just move forward with it.
9056                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9057                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9058                         },
9059                         _ => panic!("Unexpected event"),
9060                 }
9061         }
9062
9063         // Now try to create a second channel which has a duplicate funding output.
9064         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9065         let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9066         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
9067         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()));
9068         create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
9069
9070         let funding_created = {
9071                 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
9072                 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
9073                 let logger = test_utils::TestLogger::new();
9074                 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
9075         };
9076         check_added_monitors!(nodes[0], 0);
9077         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
9078         // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
9079         // still needs to be cleared here.
9080         check_added_monitors!(nodes[1], 1);
9081
9082         // ...still, nodes[1] will reject the duplicate channel.
9083         {
9084                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9085                 assert_eq!(events.len(), 1);
9086                 match events[0] {
9087                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9088                                 // Technically, at this point, nodes[1] would be justified in thinking both
9089                                 // channels are closed, but currently we do not, so we just move forward with it.
9090                                 assert_eq!(msg.channel_id, channel_id);
9091                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9092                         },
9093                         _ => panic!("Unexpected event"),
9094                 }
9095         }
9096
9097         // finally, finish creating the original channel and send a payment over it to make sure
9098         // everything is functional.
9099         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9100         {
9101                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9102                 assert_eq!(added_monitors.len(), 1);
9103                 assert_eq!(added_monitors[0].0, funding_output);
9104                 added_monitors.clear();
9105         }
9106
9107         let events_4 = nodes[0].node.get_and_clear_pending_events();
9108         assert_eq!(events_4.len(), 0);
9109         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9110         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
9111
9112         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9113         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9114         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9115         send_payment(&nodes[0], &[&nodes[1]], 8000000);
9116 }
9117
9118 #[test]
9119 fn test_error_chans_closed() {
9120         // Test that we properly handle error messages, closing appropriate channels.
9121         //
9122         // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9123         // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9124         // we can test various edge cases around it to ensure we don't regress.
9125         let chanmon_cfgs = create_chanmon_cfgs(3);
9126         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9127         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9128         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9129
9130         // Create some initial channels
9131         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9132         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9133         let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9134
9135         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9136         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9137         assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9138
9139         // Closing a channel from a different peer has no effect
9140         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9141         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9142
9143         // Closing one channel doesn't impact others
9144         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9145         check_added_monitors!(nodes[0], 1);
9146         check_closed_broadcast!(nodes[0], false);
9147         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9148         assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9149         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);
9150         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);
9151
9152         // A null channel ID should close all channels
9153         let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9154         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9155         check_added_monitors!(nodes[0], 2);
9156         let events = nodes[0].node.get_and_clear_pending_msg_events();
9157         assert_eq!(events.len(), 2);
9158         match events[0] {
9159                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9160                         assert_eq!(msg.contents.flags & 2, 2);
9161                 },
9162                 _ => panic!("Unexpected event"),
9163         }
9164         match events[1] {
9165                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9166                         assert_eq!(msg.contents.flags & 2, 2);
9167                 },
9168                 _ => panic!("Unexpected event"),
9169         }
9170         // Note that at this point users of a standard PeerHandler will end up calling
9171         // peer_disconnected with no_connection_possible set to false, duplicating the
9172         // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9173         // users with their own peer handling logic. We duplicate the call here, however.
9174         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9175         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9176
9177         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9178         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9179         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9180 }
9181
9182 #[test]
9183 fn test_invalid_funding_tx() {
9184         // Test that we properly handle invalid funding transactions sent to us from a peer.
9185         //
9186         // Previously, all other major lightning implementations had failed to properly sanitize
9187         // funding transactions from their counterparties, leading to a multi-implementation critical
9188         // security vulnerability (though we always sanitized properly, we've previously had
9189         // un-released crashes in the sanitization process).
9190         let chanmon_cfgs = create_chanmon_cfgs(2);
9191         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9192         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9193         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9194
9195         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9196         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()));
9197         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()));
9198
9199         let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9200         for output in tx.output.iter_mut() {
9201                 // Make the confirmed funding transaction have a bogus script_pubkey
9202                 output.script_pubkey = bitcoin::Script::new();
9203         }
9204
9205         nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9206         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()));
9207         check_added_monitors!(nodes[1], 1);
9208
9209         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()));
9210         check_added_monitors!(nodes[0], 1);
9211
9212         let events_1 = nodes[0].node.get_and_clear_pending_events();
9213         assert_eq!(events_1.len(), 0);
9214
9215         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9216         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9217         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9218
9219         confirm_transaction_at(&nodes[1], &tx, 1);
9220         check_added_monitors!(nodes[1], 1);
9221         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9222         assert_eq!(events_2.len(), 1);
9223         if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9224                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9225                 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9226                         assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9227                 } else { panic!(); }
9228         } else { panic!(); }
9229         assert_eq!(nodes[1].node.list_channels().len(), 0);
9230 }