_ 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, MIN_CLTV_EXPIRY_DELTA};
  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::{Arc, 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         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
1500
1501         // Check we only broadcast 1 timeout tx
1502         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1503         assert_eq!(claim_txn.len(), 8);
1504         assert_eq!(claim_txn[1], claim_txn[4]);
1505         assert_eq!(claim_txn[2], claim_txn[5]);
1506         check_spends!(claim_txn[1], chan_1.3);
1507         check_spends!(claim_txn[2], claim_txn[1]);
1508         check_spends!(claim_txn[7], claim_txn[1]);
1509
1510         assert_eq!(claim_txn[0].input.len(), 1);
1511         assert_eq!(claim_txn[3].input.len(), 1);
1512         assert_eq!(claim_txn[0].input[0].previous_output, claim_txn[3].input[0].previous_output);
1513
1514         assert_eq!(claim_txn[0].input.len(), 1);
1515         assert_eq!(claim_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1516         check_spends!(claim_txn[0], remote_txn[0]);
1517         assert_eq!(remote_txn[0].output[claim_txn[0].input[0].previous_output.vout as usize].value, 800);
1518         assert_eq!(claim_txn[6].input.len(), 1);
1519         assert_eq!(claim_txn[6].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1520         check_spends!(claim_txn[6], remote_txn[0]);
1521         assert_eq!(remote_txn[0].output[claim_txn[6].input[0].previous_output.vout as usize].value, 900);
1522
1523         let events = nodes[0].node.get_and_clear_pending_msg_events();
1524         assert_eq!(events.len(), 3);
1525         for e in events {
1526                 match e {
1527                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1528                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1529                                 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1530                                 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1531                         },
1532                         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, .. } } => {
1533                                 assert!(update_add_htlcs.is_empty());
1534                                 assert!(update_fail_htlcs.is_empty());
1535                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1536                                 assert!(update_fail_malformed_htlcs.is_empty());
1537                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1538                         },
1539                         _ => panic!("Unexpected event"),
1540                 }
1541         }
1542 }
1543
1544 #[test]
1545 fn test_basic_channel_reserve() {
1546         let chanmon_cfgs = create_chanmon_cfgs(2);
1547         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1548         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1549         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1550         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1551         let logger = test_utils::TestLogger::new();
1552
1553         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1554         let channel_reserve = chan_stat.channel_reserve_msat;
1555
1556         // The 2* and +1 are for the fee spike reserve.
1557         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
1558         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1559         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1560         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1561         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();
1562         let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).err().unwrap();
1563         match err {
1564                 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1565                         match &fails[0] {
1566                                 &APIError::ChannelUnavailable{ref err} =>
1567                                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1568                                 _ => panic!("Unexpected error variant"),
1569                         }
1570                 },
1571                 _ => panic!("Unexpected error variant"),
1572         }
1573         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1574         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);
1575
1576         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1577 }
1578
1579 #[test]
1580 fn test_fee_spike_violation_fails_htlc() {
1581         let chanmon_cfgs = create_chanmon_cfgs(2);
1582         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1583         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1584         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1585         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1586
1587         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1588         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1589         let secp_ctx = Secp256k1::new();
1590         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1591
1592         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1593
1594         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1595         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height).unwrap();
1596         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1597         let msg = msgs::UpdateAddHTLC {
1598                 channel_id: chan.2,
1599                 htlc_id: 0,
1600                 amount_msat: htlc_msat,
1601                 payment_hash: payment_hash,
1602                 cltv_expiry: htlc_cltv,
1603                 onion_routing_packet: onion_packet,
1604         };
1605
1606         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1607
1608         // Now manually create the commitment_signed message corresponding to the update_add
1609         // nodes[0] just sent. In the code for construction of this message, "local" refers
1610         // to the sender of the message, and "remote" refers to the receiver.
1611
1612         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1613
1614         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1615
1616         // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1617         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1618         let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point) = {
1619                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1620                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1621                 let chan_signer = local_chan.get_signer();
1622                 let pubkeys = chan_signer.pubkeys();
1623                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1624                  chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1625                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx))
1626         };
1627         let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point) = {
1628                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1629                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1630                 let chan_signer = remote_chan.get_signer();
1631                 let pubkeys = chan_signer.pubkeys();
1632                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1633                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx))
1634         };
1635
1636         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1637         let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1638                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1639
1640         // Build the remote commitment transaction so we can sign it, and then later use the
1641         // signature for the commitment_signed message.
1642         let local_chan_balance = 1313;
1643
1644         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1645                 offered: false,
1646                 amount_msat: 3460001,
1647                 cltv_expiry: htlc_cltv,
1648                 payment_hash,
1649                 transaction_output_index: Some(1),
1650         };
1651
1652         let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1653
1654         let res = {
1655                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1656                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1657                 let local_chan_signer = local_chan.get_signer();
1658                 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1659                         commitment_number,
1660                         95000,
1661                         local_chan_balance,
1662                         commit_tx_keys.clone(),
1663                         feerate_per_kw,
1664                         &mut vec![(accepted_htlc_info, ())],
1665                         &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1666                 );
1667                 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1668         };
1669
1670         let commit_signed_msg = msgs::CommitmentSigned {
1671                 channel_id: chan.2,
1672                 signature: res.0,
1673                 htlc_signatures: res.1
1674         };
1675
1676         // Send the commitment_signed message to the nodes[1].
1677         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1678         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1679
1680         // Send the RAA to nodes[1].
1681         let raa_msg = msgs::RevokeAndACK {
1682                 channel_id: chan.2,
1683                 per_commitment_secret: local_secret,
1684                 next_per_commitment_point: next_local_point
1685         };
1686         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1687
1688         let events = nodes[1].node.get_and_clear_pending_msg_events();
1689         assert_eq!(events.len(), 1);
1690         // Make sure the HTLC failed in the way we expect.
1691         match events[0] {
1692                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1693                         assert_eq!(update_fail_htlcs.len(), 1);
1694                         update_fail_htlcs[0].clone()
1695                 },
1696                 _ => panic!("Unexpected event"),
1697         };
1698         nodes[1].logger.assert_log("lightning::ln::channel".to_string(), "Attempting to fail HTLC due to fee spike buffer violation".to_string(), 1);
1699
1700         check_added_monitors!(nodes[1], 2);
1701 }
1702
1703 #[test]
1704 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1705         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1706         // Set the fee rate for the channel very high, to the point where the fundee
1707         // sending any above-dust amount would result in a channel reserve violation.
1708         // In this test we check that we would be prevented from sending an HTLC in
1709         // this situation.
1710         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1711         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1712         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1713         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1714         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1715         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1716
1717         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 4843000);
1718         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1719                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1720         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1721         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);
1722 }
1723
1724 #[test]
1725 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1726         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1727         // Set the fee rate for the channel very high, to the point where the funder
1728         // receiving 1 update_add_htlc would result in them closing the channel due
1729         // to channel reserve violation. This close could also happen if the fee went
1730         // up a more realistic amount, but many HTLCs were outstanding at the time of
1731         // the update_add_htlc.
1732         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1733         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1734         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1735         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1736         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1737         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1738
1739         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1740         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1741         let secp_ctx = Secp256k1::new();
1742         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1743         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1744         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1745         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height).unwrap();
1746         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1747         let msg = msgs::UpdateAddHTLC {
1748                 channel_id: chan.2,
1749                 htlc_id: 1,
1750                 amount_msat: htlc_msat + 1,
1751                 payment_hash: payment_hash,
1752                 cltv_expiry: htlc_cltv,
1753                 onion_routing_packet: onion_packet,
1754         };
1755
1756         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1757         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1758         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);
1759         assert_eq!(nodes[0].node.list_channels().len(), 0);
1760         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1761         assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1762         check_added_monitors!(nodes[0], 1);
1763 }
1764
1765 #[test]
1766 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1767         // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1768         // calculating our commitment transaction fee (this was previously broken).
1769         let chanmon_cfgs = create_chanmon_cfgs(2);
1770         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1771         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1772         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1773
1774         // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1775         // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1776         // transaction fee with 0 HTLCs (183 sats)).
1777         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98817000, InitFeatures::known(), InitFeatures::known());
1778
1779         let dust_amt = 329000; // Dust amount
1780         // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1781         // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1782         // commitment transaction fee.
1783         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1784 }
1785
1786 #[test]
1787 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1788         // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1789         // calculating our counterparty's commitment transaction fee (this was previously broken).
1790         let chanmon_cfgs = create_chanmon_cfgs(2);
1791         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1792         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1793         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1794         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1795
1796         let payment_amt = 46000; // Dust amount
1797         // In the previous code, these first four payments would succeed.
1798         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1799         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1800         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1801         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1802
1803         // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1804         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1805         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1806         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1807         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1808         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1809
1810         // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1811         // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1812         // transaction fee and therefore perceived this next payment as a channel reserve violation.
1813         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1814 }
1815
1816 #[test]
1817 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1818         let chanmon_cfgs = create_chanmon_cfgs(3);
1819         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1820         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1821         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1822         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1823         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1824
1825         let feemsat = 239;
1826         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1827         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1828         let feerate = get_feerate!(nodes[0], chan.2);
1829
1830         // Add a 2* and +1 for the fee spike reserve.
1831         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1832         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;
1833         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1834
1835         // Add a pending HTLC.
1836         let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1837         let payment_event_1 = {
1838                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1839                 check_added_monitors!(nodes[0], 1);
1840
1841                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1842                 assert_eq!(events.len(), 1);
1843                 SendEvent::from_event(events.remove(0))
1844         };
1845         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1846
1847         // Attempt to trigger a channel reserve violation --> payment failure.
1848         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1849         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;
1850         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1851         let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1852
1853         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1854         let secp_ctx = Secp256k1::new();
1855         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1856         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1857         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1858         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1859         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1860         let msg = msgs::UpdateAddHTLC {
1861                 channel_id: chan.2,
1862                 htlc_id: 1,
1863                 amount_msat: htlc_msat + 1,
1864                 payment_hash: our_payment_hash_1,
1865                 cltv_expiry: htlc_cltv,
1866                 onion_routing_packet: onion_packet,
1867         };
1868
1869         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1870         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1871         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1872         assert_eq!(nodes[1].node.list_channels().len(), 1);
1873         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1874         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1875         check_added_monitors!(nodes[1], 1);
1876 }
1877
1878 #[test]
1879 fn test_inbound_outbound_capacity_is_not_zero() {
1880         let chanmon_cfgs = create_chanmon_cfgs(2);
1881         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1882         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1883         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1884         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1885         let channels0 = node_chanmgrs[0].list_channels();
1886         let channels1 = node_chanmgrs[1].list_channels();
1887         assert_eq!(channels0.len(), 1);
1888         assert_eq!(channels1.len(), 1);
1889
1890         assert_eq!(channels0[0].inbound_capacity_msat, 95000000);
1891         assert_eq!(channels1[0].outbound_capacity_msat, 95000000);
1892
1893         assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000);
1894         assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000);
1895 }
1896
1897 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1898         (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1899 }
1900
1901 #[test]
1902 fn test_channel_reserve_holding_cell_htlcs() {
1903         let chanmon_cfgs = create_chanmon_cfgs(3);
1904         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1905         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1906         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1907         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1908         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1909
1910         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1911         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1912
1913         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1914         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1915
1916         macro_rules! expect_forward {
1917                 ($node: expr) => {{
1918                         let mut events = $node.node.get_and_clear_pending_msg_events();
1919                         assert_eq!(events.len(), 1);
1920                         check_added_monitors!($node, 1);
1921                         let payment_event = SendEvent::from_event(events.remove(0));
1922                         payment_event
1923                 }}
1924         }
1925
1926         let feemsat = 239; // somehow we know?
1927         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1928         let feerate = get_feerate!(nodes[0], chan_1.2);
1929
1930         let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1931
1932         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1933         {
1934                 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1935                 route.paths[0].last_mut().unwrap().fee_msat += 1;
1936                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1937                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1938                         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)));
1939                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1940                 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);
1941         }
1942
1943         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1944         // nodes[0]'s wealth
1945         loop {
1946                 let amt_msat = recv_value_0 + total_fee_msat;
1947                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1948                 // Also, ensure that each payment has enough to be over the dust limit to
1949                 // ensure it'll be included in each commit tx fee calculation.
1950                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1951                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1952                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1953                         break;
1954                 }
1955                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1956
1957                 let (stat01_, stat11_, stat12_, stat22_) = (
1958                         get_channel_value_stat!(nodes[0], chan_1.2),
1959                         get_channel_value_stat!(nodes[1], chan_1.2),
1960                         get_channel_value_stat!(nodes[1], chan_2.2),
1961                         get_channel_value_stat!(nodes[2], chan_2.2),
1962                 );
1963
1964                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1965                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1966                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1967                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1968                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1969         }
1970
1971         // adding pending output.
1972         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1973         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1974         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1975         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1976         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1977         // cases where 1 msat over X amount will cause a payment failure, but anything less than
1978         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1979         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1980         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1981         // policy.
1982         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1983         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1984         let amt_msat_1 = recv_value_1 + total_fee_msat;
1985
1986         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);
1987         let payment_event_1 = {
1988                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1989                 check_added_monitors!(nodes[0], 1);
1990
1991                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1992                 assert_eq!(events.len(), 1);
1993                 SendEvent::from_event(events.remove(0))
1994         };
1995         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1996
1997         // channel reserve test with htlc pending output > 0
1998         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1999         {
2000                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
2001                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2002                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2003                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2004         }
2005
2006         // split the rest to test holding cell
2007         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
2008         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2009         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2010         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2011         {
2012                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2013                 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);
2014         }
2015
2016         // now see if they go through on both sides
2017         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);
2018         // but this will stuck in the holding cell
2019         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
2020         check_added_monitors!(nodes[0], 0);
2021         let events = nodes[0].node.get_and_clear_pending_events();
2022         assert_eq!(events.len(), 0);
2023
2024         // test with outbound holding cell amount > 0
2025         {
2026                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
2027                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2028                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2029                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2030                 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);
2031         }
2032
2033         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);
2034         // this will also stuck in the holding cell
2035         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
2036         check_added_monitors!(nodes[0], 0);
2037         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2038         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2039
2040         // flush the pending htlc
2041         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2042         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2043         check_added_monitors!(nodes[1], 1);
2044
2045         // the pending htlc should be promoted to committed
2046         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2047         check_added_monitors!(nodes[0], 1);
2048         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2049
2050         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2051         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2052         // No commitment_signed so get_event_msg's assert(len == 1) passes
2053         check_added_monitors!(nodes[0], 1);
2054
2055         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2056         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2057         check_added_monitors!(nodes[1], 1);
2058
2059         expect_pending_htlcs_forwardable!(nodes[1]);
2060
2061         let ref payment_event_11 = expect_forward!(nodes[1]);
2062         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2063         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2064
2065         expect_pending_htlcs_forwardable!(nodes[2]);
2066         expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
2067
2068         // flush the htlcs in the holding cell
2069         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2070         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2071         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2072         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2073         expect_pending_htlcs_forwardable!(nodes[1]);
2074
2075         let ref payment_event_3 = expect_forward!(nodes[1]);
2076         assert_eq!(payment_event_3.msgs.len(), 2);
2077         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2078         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2079
2080         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2081         expect_pending_htlcs_forwardable!(nodes[2]);
2082
2083         let events = nodes[2].node.get_and_clear_pending_events();
2084         assert_eq!(events.len(), 2);
2085         match events[0] {
2086                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2087                         assert_eq!(our_payment_hash_21, *payment_hash);
2088                         assert!(payment_preimage.is_none());
2089                         assert_eq!(our_payment_secret_21, *payment_secret);
2090                         assert_eq!(recv_value_21, amt);
2091                 },
2092                 _ => panic!("Unexpected event"),
2093         }
2094         match events[1] {
2095                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2096                         assert_eq!(our_payment_hash_22, *payment_hash);
2097                         assert!(payment_preimage.is_none());
2098                         assert_eq!(our_payment_secret_22, *payment_secret);
2099                         assert_eq!(recv_value_22, amt);
2100                 },
2101                 _ => panic!("Unexpected event"),
2102         }
2103
2104         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
2105         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
2106         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
2107
2108         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2109         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2110         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
2111
2112         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2113         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);
2114         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2115         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2116         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2117
2118         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2119         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2120 }
2121
2122 #[test]
2123 fn channel_reserve_in_flight_removes() {
2124         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2125         // can send to its counterparty, but due to update ordering, the other side may not yet have
2126         // considered those HTLCs fully removed.
2127         // This tests that we don't count HTLCs which will not be included in the next remote
2128         // commitment transaction towards the reserve value (as it implies no commitment transaction
2129         // will be generated which violates the remote reserve value).
2130         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2131         // To test this we:
2132         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2133         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2134         //    you only consider the value of the first HTLC, it may not),
2135         //  * start routing a third HTLC from A to B,
2136         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2137         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2138         //  * deliver the first fulfill from B
2139         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2140         //    claim,
2141         //  * deliver A's response CS and RAA.
2142         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2143         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
2144         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2145         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2146         let chanmon_cfgs = create_chanmon_cfgs(2);
2147         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2148         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2149         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2150         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2151         let logger = test_utils::TestLogger::new();
2152
2153         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2154         // Route the first two HTLCs.
2155         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2156         let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2157
2158         // Start routing the third HTLC (this is just used to get everyone in the right state).
2159         let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
2160         let send_1 = {
2161                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2162                 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();
2163                 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
2164                 check_added_monitors!(nodes[0], 1);
2165                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2166                 assert_eq!(events.len(), 1);
2167                 SendEvent::from_event(events.remove(0))
2168         };
2169
2170         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2171         // initial fulfill/CS.
2172         assert!(nodes[1].node.claim_funds(payment_preimage_1));
2173         check_added_monitors!(nodes[1], 1);
2174         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2175
2176         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2177         // remove the second HTLC when we send the HTLC back from B to A.
2178         assert!(nodes[1].node.claim_funds(payment_preimage_2));
2179         check_added_monitors!(nodes[1], 1);
2180         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2181
2182         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2183         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2184         check_added_monitors!(nodes[0], 1);
2185         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2186         expect_payment_sent!(nodes[0], payment_preimage_1);
2187
2188         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2189         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2190         check_added_monitors!(nodes[1], 1);
2191         // B is already AwaitingRAA, so cant generate a CS here
2192         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2193
2194         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2195         check_added_monitors!(nodes[1], 1);
2196         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2197
2198         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2199         check_added_monitors!(nodes[0], 1);
2200         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2201
2202         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2203         check_added_monitors!(nodes[1], 1);
2204         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2205
2206         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2207         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2208         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2209         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2210         // on-chain as necessary).
2211         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2212         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2213         check_added_monitors!(nodes[0], 1);
2214         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2215         expect_payment_sent!(nodes[0], payment_preimage_2);
2216
2217         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2218         check_added_monitors!(nodes[1], 1);
2219         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2220
2221         expect_pending_htlcs_forwardable!(nodes[1]);
2222         expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
2223
2224         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2225         // resolve the second HTLC from A's point of view.
2226         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2227         check_added_monitors!(nodes[0], 1);
2228         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2229
2230         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2231         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2232         let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
2233         let send_2 = {
2234                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2235                 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();
2236                 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
2237                 check_added_monitors!(nodes[1], 1);
2238                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2239                 assert_eq!(events.len(), 1);
2240                 SendEvent::from_event(events.remove(0))
2241         };
2242
2243         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2244         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2245         check_added_monitors!(nodes[0], 1);
2246         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2247
2248         // Now just resolve all the outstanding messages/HTLCs for completeness...
2249
2250         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2251         check_added_monitors!(nodes[1], 1);
2252         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2253
2254         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2255         check_added_monitors!(nodes[1], 1);
2256
2257         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2258         check_added_monitors!(nodes[0], 1);
2259         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2260
2261         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2262         check_added_monitors!(nodes[1], 1);
2263         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2264
2265         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2266         check_added_monitors!(nodes[0], 1);
2267
2268         expect_pending_htlcs_forwardable!(nodes[0]);
2269         expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2270
2271         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2272         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2273 }
2274
2275 #[test]
2276 fn channel_monitor_network_test() {
2277         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2278         // tests that ChannelMonitor is able to recover from various states.
2279         let chanmon_cfgs = create_chanmon_cfgs(5);
2280         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2281         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2282         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2283
2284         // Create some initial channels
2285         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2286         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2287         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2288         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2289
2290         // Make sure all nodes are at the same starting height
2291         connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2292         connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2293         connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2294         connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2295         connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2296
2297         // Rebalance the network a bit by relaying one payment through all the channels...
2298         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2299         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2300         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2301         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2302
2303         // Simple case with no pending HTLCs:
2304         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2305         check_added_monitors!(nodes[1], 1);
2306         check_closed_broadcast!(nodes[1], false);
2307         {
2308                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2309                 assert_eq!(node_txn.len(), 1);
2310                 mine_transaction(&nodes[0], &node_txn[0]);
2311                 check_added_monitors!(nodes[0], 1);
2312                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2313         }
2314         check_closed_broadcast!(nodes[0], true);
2315         assert_eq!(nodes[0].node.list_channels().len(), 0);
2316         assert_eq!(nodes[1].node.list_channels().len(), 1);
2317
2318         // One pending HTLC is discarded by the force-close:
2319         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2320
2321         // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2322         // broadcasted until we reach the timelock time).
2323         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2324         check_closed_broadcast!(nodes[1], false);
2325         check_added_monitors!(nodes[1], 1);
2326         {
2327                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2328                 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2329                 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2330                 mine_transaction(&nodes[2], &node_txn[0]);
2331                 check_added_monitors!(nodes[2], 1);
2332                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2333         }
2334         check_closed_broadcast!(nodes[2], true);
2335         assert_eq!(nodes[1].node.list_channels().len(), 0);
2336         assert_eq!(nodes[2].node.list_channels().len(), 1);
2337
2338         macro_rules! claim_funds {
2339                 ($node: expr, $prev_node: expr, $preimage: expr) => {
2340                         {
2341                                 assert!($node.node.claim_funds($preimage));
2342                                 check_added_monitors!($node, 1);
2343
2344                                 let events = $node.node.get_and_clear_pending_msg_events();
2345                                 assert_eq!(events.len(), 1);
2346                                 match events[0] {
2347                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2348                                                 assert!(update_add_htlcs.is_empty());
2349                                                 assert!(update_fail_htlcs.is_empty());
2350                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2351                                         },
2352                                         _ => panic!("Unexpected event"),
2353                                 };
2354                         }
2355                 }
2356         }
2357
2358         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2359         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2360         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2361         check_added_monitors!(nodes[2], 1);
2362         check_closed_broadcast!(nodes[2], false);
2363         let node2_commitment_txid;
2364         {
2365                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2366                 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2367                 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2368                 node2_commitment_txid = node_txn[0].txid();
2369
2370                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2371                 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2372                 mine_transaction(&nodes[3], &node_txn[0]);
2373                 check_added_monitors!(nodes[3], 1);
2374                 check_preimage_claim(&nodes[3], &node_txn);
2375         }
2376         check_closed_broadcast!(nodes[3], true);
2377         assert_eq!(nodes[2].node.list_channels().len(), 0);
2378         assert_eq!(nodes[3].node.list_channels().len(), 1);
2379
2380         // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2381         // confusing us in the following tests.
2382         let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2383
2384         // One pending HTLC to time out:
2385         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2386         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2387         // buffer space).
2388
2389         let (close_chan_update_1, close_chan_update_2) = {
2390                 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2391                 let events = nodes[3].node.get_and_clear_pending_msg_events();
2392                 assert_eq!(events.len(), 2);
2393                 let close_chan_update_1 = match events[0] {
2394                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2395                                 msg.clone()
2396                         },
2397                         _ => panic!("Unexpected event"),
2398                 };
2399                 match events[1] {
2400                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2401                                 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2402                         },
2403                         _ => panic!("Unexpected event"),
2404                 }
2405                 check_added_monitors!(nodes[3], 1);
2406
2407                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2408                 {
2409                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2410                         node_txn.retain(|tx| {
2411                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2412                                         false
2413                                 } else { true }
2414                         });
2415                 }
2416
2417                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2418
2419                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2420                 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2421
2422                 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2423                 let events = nodes[4].node.get_and_clear_pending_msg_events();
2424                 assert_eq!(events.len(), 2);
2425                 let close_chan_update_2 = match events[0] {
2426                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2427                                 msg.clone()
2428                         },
2429                         _ => panic!("Unexpected event"),
2430                 };
2431                 match events[1] {
2432                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2433                                 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2434                         },
2435                         _ => panic!("Unexpected event"),
2436                 }
2437                 check_added_monitors!(nodes[4], 1);
2438                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2439
2440                 mine_transaction(&nodes[4], &node_txn[0]);
2441                 check_preimage_claim(&nodes[4], &node_txn);
2442                 (close_chan_update_1, close_chan_update_2)
2443         };
2444         nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2445         nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2446         assert_eq!(nodes[3].node.list_channels().len(), 0);
2447         assert_eq!(nodes[4].node.list_channels().len(), 0);
2448
2449         nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2450 }
2451
2452 #[test]
2453 fn test_justice_tx() {
2454         // Test justice txn built on revoked HTLC-Success tx, against both sides
2455         let mut alice_config = UserConfig::default();
2456         alice_config.channel_options.announced_channel = true;
2457         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2458         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2459         let mut bob_config = UserConfig::default();
2460         bob_config.channel_options.announced_channel = true;
2461         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2462         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2463         let user_cfgs = [Some(alice_config), Some(bob_config)];
2464         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2465         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2466         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2467         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2468         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2469         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2470         // Create some new channels:
2471         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2472
2473         // A pending HTLC which will be revoked:
2474         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2475         // Get the will-be-revoked local txn from nodes[0]
2476         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2477         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2478         assert_eq!(revoked_local_txn[0].input.len(), 1);
2479         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2480         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2481         assert_eq!(revoked_local_txn[1].input.len(), 1);
2482         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2483         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2484         // Revoke the old state
2485         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2486
2487         {
2488                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2489                 {
2490                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2491                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2492                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2493
2494                         check_spends!(node_txn[0], revoked_local_txn[0]);
2495                         node_txn.swap_remove(0);
2496                         node_txn.truncate(1);
2497                 }
2498                 check_added_monitors!(nodes[1], 1);
2499                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2500
2501                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2502                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2503                 // Verify broadcast of revoked HTLC-timeout
2504                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2505                 check_added_monitors!(nodes[0], 1);
2506                 // Broadcast revoked HTLC-timeout on node 1
2507                 mine_transaction(&nodes[1], &node_txn[1]);
2508                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2509         }
2510         get_announce_close_broadcast_events(&nodes, 0, 1);
2511
2512         assert_eq!(nodes[0].node.list_channels().len(), 0);
2513         assert_eq!(nodes[1].node.list_channels().len(), 0);
2514
2515         // We test justice_tx build by A on B's revoked HTLC-Success tx
2516         // Create some new channels:
2517         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2518         {
2519                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2520                 node_txn.clear();
2521         }
2522
2523         // A pending HTLC which will be revoked:
2524         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2525         // Get the will-be-revoked local txn from B
2526         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2527         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2528         assert_eq!(revoked_local_txn[0].input.len(), 1);
2529         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2530         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2531         // Revoke the old state
2532         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2533         {
2534                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2535                 {
2536                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2537                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2538                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2539
2540                         check_spends!(node_txn[0], revoked_local_txn[0]);
2541                         node_txn.swap_remove(0);
2542                 }
2543                 check_added_monitors!(nodes[0], 1);
2544                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2545
2546                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2547                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2548                 check_added_monitors!(nodes[1], 1);
2549                 mine_transaction(&nodes[0], &node_txn[1]);
2550                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2551         }
2552         get_announce_close_broadcast_events(&nodes, 0, 1);
2553         assert_eq!(nodes[0].node.list_channels().len(), 0);
2554         assert_eq!(nodes[1].node.list_channels().len(), 0);
2555 }
2556
2557 #[test]
2558 fn revoked_output_claim() {
2559         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2560         // transaction is broadcast by its counterparty
2561         let chanmon_cfgs = create_chanmon_cfgs(2);
2562         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2563         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2564         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2565         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2566         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2567         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2568         assert_eq!(revoked_local_txn.len(), 1);
2569         // Only output is the full channel value back to nodes[0]:
2570         assert_eq!(revoked_local_txn[0].output.len(), 1);
2571         // Send a payment through, updating everyone's latest commitment txn
2572         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2573
2574         // Inform nodes[1] that nodes[0] broadcast a stale tx
2575         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2576         check_added_monitors!(nodes[1], 1);
2577         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2578         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2579
2580         check_spends!(node_txn[0], revoked_local_txn[0]);
2581         check_spends!(node_txn[1], chan_1.3);
2582
2583         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2584         mine_transaction(&nodes[0], &revoked_local_txn[0]);
2585         get_announce_close_broadcast_events(&nodes, 0, 1);
2586         check_added_monitors!(nodes[0], 1)
2587 }
2588
2589 #[test]
2590 fn claim_htlc_outputs_shared_tx() {
2591         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2592         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2593         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2594         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2595         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2596         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2597
2598         // Create some new channel:
2599         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2600
2601         // Rebalance the network to generate htlc in the two directions
2602         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2603         // 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
2604         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2605         let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2606
2607         // Get the will-be-revoked local txn from node[0]
2608         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2609         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2610         assert_eq!(revoked_local_txn[0].input.len(), 1);
2611         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2612         assert_eq!(revoked_local_txn[1].input.len(), 1);
2613         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2614         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2615         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2616
2617         //Revoke the old state
2618         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2619
2620         {
2621                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2622                 check_added_monitors!(nodes[0], 1);
2623                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2624                 check_added_monitors!(nodes[1], 1);
2625                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2626                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2627
2628                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2629                 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment
2630
2631                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2632                 check_spends!(node_txn[0], revoked_local_txn[0]);
2633
2634                 let mut witness_lens = BTreeSet::new();
2635                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2636                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2637                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2638                 assert_eq!(witness_lens.len(), 3);
2639                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2640                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2641                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2642
2643                 // Next nodes[1] broadcasts its current local tx state:
2644                 assert_eq!(node_txn[1].input.len(), 1);
2645                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2646         }
2647         get_announce_close_broadcast_events(&nodes, 0, 1);
2648         assert_eq!(nodes[0].node.list_channels().len(), 0);
2649         assert_eq!(nodes[1].node.list_channels().len(), 0);
2650 }
2651
2652 #[test]
2653 fn claim_htlc_outputs_single_tx() {
2654         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2655         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2656         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2657         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2658         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2659         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2660
2661         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2662
2663         // Rebalance the network to generate htlc in the two directions
2664         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2665         // 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
2666         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2667         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2668         let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2669
2670         // Get the will-be-revoked local txn from node[0]
2671         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2672
2673         //Revoke the old state
2674         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2675
2676         {
2677                 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2678                 check_added_monitors!(nodes[0], 1);
2679                 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2680                 check_added_monitors!(nodes[1], 1);
2681                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2682
2683                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2684                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2685
2686                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2687                 assert_eq!(node_txn.len(), 9);
2688                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2689                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2690                 // 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)
2691                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2692
2693                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2694                 assert_eq!(node_txn[0].input.len(), 1);
2695                 check_spends!(node_txn[0], chan_1.3);
2696                 assert_eq!(node_txn[1].input.len(), 1);
2697                 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2698                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2699                 check_spends!(node_txn[1], node_txn[0]);
2700
2701                 // Justice transactions are indices 1-2-4
2702                 assert_eq!(node_txn[2].input.len(), 1);
2703                 assert_eq!(node_txn[3].input.len(), 1);
2704                 assert_eq!(node_txn[4].input.len(), 1);
2705
2706                 check_spends!(node_txn[2], revoked_local_txn[0]);
2707                 check_spends!(node_txn[3], revoked_local_txn[0]);
2708                 check_spends!(node_txn[4], revoked_local_txn[0]);
2709
2710                 let mut witness_lens = BTreeSet::new();
2711                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2712                 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2713                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2714                 assert_eq!(witness_lens.len(), 3);
2715                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2716                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2717                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2718         }
2719         get_announce_close_broadcast_events(&nodes, 0, 1);
2720         assert_eq!(nodes[0].node.list_channels().len(), 0);
2721         assert_eq!(nodes[1].node.list_channels().len(), 0);
2722 }
2723
2724 #[test]
2725 fn test_htlc_on_chain_success() {
2726         // Test that in case of a unilateral close onchain, we detect the state of output and pass
2727         // the preimage backward accordingly. So here we test that ChannelManager is
2728         // broadcasting the right event to other nodes in payment path.
2729         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2730         // A --------------------> B ----------------------> C (preimage)
2731         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2732         // commitment transaction was broadcast.
2733         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2734         // towards B.
2735         // B should be able to claim via preimage if A then broadcasts its local tx.
2736         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2737         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2738         // PaymentSent event).
2739
2740         let chanmon_cfgs = create_chanmon_cfgs(3);
2741         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2742         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2743         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2744
2745         // Create some initial channels
2746         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2747         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2748
2749         // Ensure all nodes are at the same height
2750         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2751         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2752         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2753         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2754
2755         // Rebalance the network a bit by relaying one payment through all the channels...
2756         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2757         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2758
2759         let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2760         let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2761
2762         // Broadcast legit commitment tx from C on B's chain
2763         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2764         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2765         assert_eq!(commitment_tx.len(), 1);
2766         check_spends!(commitment_tx[0], chan_2.3);
2767         nodes[2].node.claim_funds(our_payment_preimage);
2768         nodes[2].node.claim_funds(our_payment_preimage_2);
2769         check_added_monitors!(nodes[2], 2);
2770         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2771         assert!(updates.update_add_htlcs.is_empty());
2772         assert!(updates.update_fail_htlcs.is_empty());
2773         assert!(updates.update_fail_malformed_htlcs.is_empty());
2774         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2775
2776         mine_transaction(&nodes[2], &commitment_tx[0]);
2777         check_closed_broadcast!(nodes[2], true);
2778         check_added_monitors!(nodes[2], 1);
2779         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)
2780         assert_eq!(node_txn.len(), 5);
2781         assert_eq!(node_txn[0], node_txn[3]);
2782         assert_eq!(node_txn[1], node_txn[4]);
2783         assert_eq!(node_txn[2], commitment_tx[0]);
2784         check_spends!(node_txn[0], commitment_tx[0]);
2785         check_spends!(node_txn[1], commitment_tx[0]);
2786         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2787         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2788         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2789         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2790         assert_eq!(node_txn[0].lock_time, 0);
2791         assert_eq!(node_txn[1].lock_time, 0);
2792
2793         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2794         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2795         connect_block(&nodes[1], &Block { header, txdata: node_txn});
2796         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2797         {
2798                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2799                 assert_eq!(added_monitors.len(), 1);
2800                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2801                 added_monitors.clear();
2802         }
2803         let events = nodes[1].node.get_and_clear_pending_msg_events();
2804         {
2805                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2806                 assert_eq!(added_monitors.len(), 2);
2807                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2808                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2809                 added_monitors.clear();
2810         }
2811         assert_eq!(events.len(), 3);
2812         match events[0] {
2813                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2814                 _ => panic!("Unexpected event"),
2815         }
2816         match events[1] {
2817                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2818                 _ => panic!("Unexpected event"),
2819         }
2820
2821         match events[2] {
2822                 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, .. } } => {
2823                         assert!(update_add_htlcs.is_empty());
2824                         assert!(update_fail_htlcs.is_empty());
2825                         assert_eq!(update_fulfill_htlcs.len(), 1);
2826                         assert!(update_fail_malformed_htlcs.is_empty());
2827                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2828                 },
2829                 _ => panic!("Unexpected event"),
2830         };
2831         macro_rules! check_tx_local_broadcast {
2832                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2833                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2834                         assert_eq!(node_txn.len(), 3);
2835                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2836                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2837                         check_spends!(node_txn[1], $commitment_tx);
2838                         check_spends!(node_txn[2], $commitment_tx);
2839                         assert_ne!(node_txn[1].lock_time, 0);
2840                         assert_ne!(node_txn[2].lock_time, 0);
2841                         if $htlc_offered {
2842                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2843                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2844                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2845                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2846                         } else {
2847                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2848                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2849                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2850                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2851                         }
2852                         check_spends!(node_txn[0], $chan_tx);
2853                         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2854                         node_txn.clear();
2855                 } }
2856         }
2857         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2858         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2859         // timeout-claim of the output that nodes[2] just claimed via success.
2860         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2861
2862         // Broadcast legit commitment tx from A on B's chain
2863         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2864         let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2865         check_spends!(node_a_commitment_tx[0], chan_1.3);
2866         mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2867         check_closed_broadcast!(nodes[1], true);
2868         check_added_monitors!(nodes[1], 1);
2869         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2870         assert_eq!(node_txn.len(), 6); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 3 (HTLC-Success, 2* RBF bumps of above HTLC txn)
2871         let commitment_spend =
2872                 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2873                         check_spends!(node_txn[1], commitment_tx[0]);
2874                         check_spends!(node_txn[2], commitment_tx[0]);
2875                         assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2876                         &node_txn[0]
2877                 } else {
2878                         check_spends!(node_txn[0], commitment_tx[0]);
2879                         check_spends!(node_txn[1], commitment_tx[0]);
2880                         assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2881                         &node_txn[2]
2882                 };
2883
2884         check_spends!(commitment_spend, node_a_commitment_tx[0]);
2885         assert_eq!(commitment_spend.input.len(), 2);
2886         assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2887         assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2888         assert_eq!(commitment_spend.lock_time, 0);
2889         assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2890         check_spends!(node_txn[3], chan_1.3);
2891         assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2892         check_spends!(node_txn[4], node_txn[3]);
2893         check_spends!(node_txn[5], node_txn[3]);
2894         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2895         // we already checked the same situation with A.
2896
2897         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2898         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2899         connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
2900         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2901         check_closed_broadcast!(nodes[0], true);
2902         check_added_monitors!(nodes[0], 1);
2903         let events = nodes[0].node.get_and_clear_pending_events();
2904         assert_eq!(events.len(), 2);
2905         let mut first_claimed = false;
2906         for event in events {
2907                 match event {
2908                         Event::PaymentSent { payment_preimage } => {
2909                                 if payment_preimage == our_payment_preimage {
2910                                         assert!(!first_claimed);
2911                                         first_claimed = true;
2912                                 } else {
2913                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2914                                 }
2915                         },
2916                         _ => panic!("Unexpected event"),
2917                 }
2918         }
2919         check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0], chan_1.3);
2920 }
2921
2922 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2923         // Test that in case of a unilateral close onchain, we detect the state of output and
2924         // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2925         // broadcasting the right event to other nodes in payment path.
2926         // A ------------------> B ----------------------> C (timeout)
2927         //    B's commitment tx                 C's commitment tx
2928         //            \                                  \
2929         //         B's HTLC timeout tx               B's timeout tx
2930
2931         let chanmon_cfgs = create_chanmon_cfgs(3);
2932         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2933         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2934         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2935         *nodes[0].connect_style.borrow_mut() = connect_style;
2936         *nodes[1].connect_style.borrow_mut() = connect_style;
2937         *nodes[2].connect_style.borrow_mut() = connect_style;
2938
2939         // Create some intial channels
2940         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2941         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2942
2943         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2944         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2945         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2946
2947         let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2948
2949         // Broadcast legit commitment tx from C on B's chain
2950         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2951         check_spends!(commitment_tx[0], chan_2.3);
2952         nodes[2].node.fail_htlc_backwards(&payment_hash);
2953         check_added_monitors!(nodes[2], 0);
2954         expect_pending_htlcs_forwardable!(nodes[2]);
2955         check_added_monitors!(nodes[2], 1);
2956
2957         let events = nodes[2].node.get_and_clear_pending_msg_events();
2958         assert_eq!(events.len(), 1);
2959         match events[0] {
2960                 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, .. } } => {
2961                         assert!(update_add_htlcs.is_empty());
2962                         assert!(!update_fail_htlcs.is_empty());
2963                         assert!(update_fulfill_htlcs.is_empty());
2964                         assert!(update_fail_malformed_htlcs.is_empty());
2965                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2966                 },
2967                 _ => panic!("Unexpected event"),
2968         };
2969         mine_transaction(&nodes[2], &commitment_tx[0]);
2970         check_closed_broadcast!(nodes[2], true);
2971         check_added_monitors!(nodes[2], 1);
2972         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2973         assert_eq!(node_txn.len(), 1);
2974         check_spends!(node_txn[0], chan_2.3);
2975         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2976
2977         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2978         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2979         connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2980         mine_transaction(&nodes[1], &commitment_tx[0]);
2981         let timeout_tx;
2982         {
2983                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2984                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2985                 assert_eq!(node_txn[0], node_txn[3]);
2986                 assert_eq!(node_txn[1], node_txn[4]);
2987
2988                 check_spends!(node_txn[2], commitment_tx[0]);
2989                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2990
2991                 check_spends!(node_txn[0], chan_2.3);
2992                 check_spends!(node_txn[1], node_txn[0]);
2993                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2994                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2995
2996                 timeout_tx = node_txn[2].clone();
2997                 node_txn.clear();
2998         }
2999
3000         mine_transaction(&nodes[1], &timeout_tx);
3001         check_added_monitors!(nodes[1], 1);
3002         check_closed_broadcast!(nodes[1], true);
3003         {
3004                 // B will rebroadcast a fee-bumped timeout transaction here.
3005                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3006                 assert_eq!(node_txn.len(), 1);
3007                 check_spends!(node_txn[0], commitment_tx[0]);
3008         }
3009
3010         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3011         {
3012                 // B will rebroadcast its own holder commitment transaction here...just because
3013                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3014                 assert_eq!(node_txn.len(), 1);
3015                 check_spends!(node_txn[0], chan_2.3);
3016         }
3017
3018         expect_pending_htlcs_forwardable!(nodes[1]);
3019         check_added_monitors!(nodes[1], 1);
3020         let events = nodes[1].node.get_and_clear_pending_msg_events();
3021         assert_eq!(events.len(), 1);
3022         match events[0] {
3023                 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, .. } } => {
3024                         assert!(update_add_htlcs.is_empty());
3025                         assert!(!update_fail_htlcs.is_empty());
3026                         assert!(update_fulfill_htlcs.is_empty());
3027                         assert!(update_fail_malformed_htlcs.is_empty());
3028                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3029                 },
3030                 _ => panic!("Unexpected event"),
3031         };
3032
3033         // Broadcast legit commitment tx from B on A's chain
3034         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3035         check_spends!(commitment_tx[0], chan_1.3);
3036
3037         mine_transaction(&nodes[0], &commitment_tx[0]);
3038         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
3039
3040         check_closed_broadcast!(nodes[0], true);
3041         check_added_monitors!(nodes[0], 1);
3042         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 commitment tx, ChannelMonitor : 1 timeout tx
3043         assert_eq!(node_txn.len(), 2);
3044         check_spends!(node_txn[0], chan_1.3);
3045         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
3046         check_spends!(node_txn[1], commitment_tx[0]);
3047         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3048 }
3049
3050 #[test]
3051 fn test_htlc_on_chain_timeout() {
3052         do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
3053         do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
3054         do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
3055 }
3056
3057 #[test]
3058 fn test_simple_commitment_revoked_fail_backward() {
3059         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3060         // and fail backward accordingly.
3061
3062         let chanmon_cfgs = create_chanmon_cfgs(3);
3063         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3064         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3065         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3066
3067         // Create some initial channels
3068         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3069         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3070
3071         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3072         // Get the will-be-revoked local txn from nodes[2]
3073         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3074         // Revoke the old state
3075         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3076
3077         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3078
3079         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3080         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3081         check_added_monitors!(nodes[1], 1);
3082         check_closed_broadcast!(nodes[1], true);
3083
3084         expect_pending_htlcs_forwardable!(nodes[1]);
3085         check_added_monitors!(nodes[1], 1);
3086         let events = nodes[1].node.get_and_clear_pending_msg_events();
3087         assert_eq!(events.len(), 1);
3088         match events[0] {
3089                 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, .. } } => {
3090                         assert!(update_add_htlcs.is_empty());
3091                         assert_eq!(update_fail_htlcs.len(), 1);
3092                         assert!(update_fulfill_htlcs.is_empty());
3093                         assert!(update_fail_malformed_htlcs.is_empty());
3094                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3095
3096                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3097                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3098
3099                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3100                         assert_eq!(events.len(), 1);
3101                         match events[0] {
3102                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3103                                 _ => panic!("Unexpected event"),
3104                         }
3105                         expect_payment_failed!(nodes[0], payment_hash, false);
3106                 },
3107                 _ => panic!("Unexpected event"),
3108         }
3109 }
3110
3111 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3112         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3113         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3114         // commitment transaction anymore.
3115         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3116         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3117         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3118         // technically disallowed and we should probably handle it reasonably.
3119         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3120         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3121         // transactions:
3122         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3123         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3124         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3125         //   and once they revoke the previous commitment transaction (allowing us to send a new
3126         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3127         let chanmon_cfgs = create_chanmon_cfgs(3);
3128         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3129         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3130         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3131
3132         // Create some initial channels
3133         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3134         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3135
3136         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 });
3137         // Get the will-be-revoked local txn from nodes[2]
3138         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3139         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3140         // Revoke the old state
3141         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3142
3143         let value = if use_dust {
3144                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3145                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3146                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3147         } else { 3000000 };
3148
3149         let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3150         let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3151         let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3152
3153         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
3154         expect_pending_htlcs_forwardable!(nodes[2]);
3155         check_added_monitors!(nodes[2], 1);
3156         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3157         assert!(updates.update_add_htlcs.is_empty());
3158         assert!(updates.update_fulfill_htlcs.is_empty());
3159         assert!(updates.update_fail_malformed_htlcs.is_empty());
3160         assert_eq!(updates.update_fail_htlcs.len(), 1);
3161         assert!(updates.update_fee.is_none());
3162         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3163         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3164         // Drop the last RAA from 3 -> 2
3165
3166         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
3167         expect_pending_htlcs_forwardable!(nodes[2]);
3168         check_added_monitors!(nodes[2], 1);
3169         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3170         assert!(updates.update_add_htlcs.is_empty());
3171         assert!(updates.update_fulfill_htlcs.is_empty());
3172         assert!(updates.update_fail_malformed_htlcs.is_empty());
3173         assert_eq!(updates.update_fail_htlcs.len(), 1);
3174         assert!(updates.update_fee.is_none());
3175         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3176         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3177         check_added_monitors!(nodes[1], 1);
3178         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3179         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3180         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3181         check_added_monitors!(nodes[2], 1);
3182
3183         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
3184         expect_pending_htlcs_forwardable!(nodes[2]);
3185         check_added_monitors!(nodes[2], 1);
3186         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3187         assert!(updates.update_add_htlcs.is_empty());
3188         assert!(updates.update_fulfill_htlcs.is_empty());
3189         assert!(updates.update_fail_malformed_htlcs.is_empty());
3190         assert_eq!(updates.update_fail_htlcs.len(), 1);
3191         assert!(updates.update_fee.is_none());
3192         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3193         // At this point first_payment_hash has dropped out of the latest two commitment
3194         // transactions that nodes[1] is tracking...
3195         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3196         check_added_monitors!(nodes[1], 1);
3197         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3198         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3199         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3200         check_added_monitors!(nodes[2], 1);
3201
3202         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3203         // on nodes[2]'s RAA.
3204         let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3205         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3206         let logger = test_utils::TestLogger::new();
3207         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();
3208         nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
3209         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3210         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3211         check_added_monitors!(nodes[1], 0);
3212
3213         if deliver_bs_raa {
3214                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3215                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3216                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3217                 check_added_monitors!(nodes[1], 1);
3218                 let events = nodes[1].node.get_and_clear_pending_events();
3219                 assert_eq!(events.len(), 1);
3220                 match events[0] {
3221                         Event::PendingHTLCsForwardable { .. } => { },
3222                         _ => panic!("Unexpected event"),
3223                 };
3224                 // Deliberately don't process the pending fail-back so they all fail back at once after
3225                 // block connection just like the !deliver_bs_raa case
3226         }
3227
3228         let mut failed_htlcs = HashSet::new();
3229         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3230
3231         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3232         check_added_monitors!(nodes[1], 1);
3233         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3234
3235         let events = nodes[1].node.get_and_clear_pending_events();
3236         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3237         match events[0] {
3238                 Event::PaymentFailed { ref payment_hash, .. } => {
3239                         assert_eq!(*payment_hash, fourth_payment_hash);
3240                 },
3241                 _ => panic!("Unexpected event"),
3242         }
3243         if !deliver_bs_raa {
3244                 match events[1] {
3245                         Event::PendingHTLCsForwardable { .. } => { },
3246                         _ => panic!("Unexpected event"),
3247                 };
3248         }
3249         nodes[1].node.process_pending_htlc_forwards();
3250         check_added_monitors!(nodes[1], 1);
3251
3252         let events = nodes[1].node.get_and_clear_pending_msg_events();
3253         assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3254         match events[if deliver_bs_raa { 1 } else { 0 }] {
3255                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3256                 _ => panic!("Unexpected event"),
3257         }
3258         match events[if deliver_bs_raa { 2 } else { 1 }] {
3259                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3260                         assert_eq!(channel_id, chan_2.2);
3261                         assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3262                 },
3263                 _ => panic!("Unexpected event"),
3264         }
3265         if deliver_bs_raa {
3266                 match events[0] {
3267                         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, .. } } => {
3268                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3269                                 assert_eq!(update_add_htlcs.len(), 1);
3270                                 assert!(update_fulfill_htlcs.is_empty());
3271                                 assert!(update_fail_htlcs.is_empty());
3272                                 assert!(update_fail_malformed_htlcs.is_empty());
3273                         },
3274                         _ => panic!("Unexpected event"),
3275                 }
3276         }
3277         match events[if deliver_bs_raa { 3 } else { 2 }] {
3278                 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, .. } } => {
3279                         assert!(update_add_htlcs.is_empty());
3280                         assert_eq!(update_fail_htlcs.len(), 3);
3281                         assert!(update_fulfill_htlcs.is_empty());
3282                         assert!(update_fail_malformed_htlcs.is_empty());
3283                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3284
3285                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3286                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3287                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3288
3289                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3290
3291                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3292                         // If we delivered B's RAA we got an unknown preimage error, not something
3293                         // that we should update our routing table for.
3294                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3295                         for event in events {
3296                                 match event {
3297                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3298                                         _ => panic!("Unexpected event"),
3299                                 }
3300                         }
3301                         let events = nodes[0].node.get_and_clear_pending_events();
3302                         assert_eq!(events.len(), 3);
3303                         match events[0] {
3304                                 Event::PaymentFailed { ref payment_hash, .. } => {
3305                                         assert!(failed_htlcs.insert(payment_hash.0));
3306                                 },
3307                                 _ => panic!("Unexpected event"),
3308                         }
3309                         match events[1] {
3310                                 Event::PaymentFailed { ref payment_hash, .. } => {
3311                                         assert!(failed_htlcs.insert(payment_hash.0));
3312                                 },
3313                                 _ => panic!("Unexpected event"),
3314                         }
3315                         match events[2] {
3316                                 Event::PaymentFailed { ref payment_hash, .. } => {
3317                                         assert!(failed_htlcs.insert(payment_hash.0));
3318                                 },
3319                                 _ => panic!("Unexpected event"),
3320                         }
3321                 },
3322                 _ => panic!("Unexpected event"),
3323         }
3324
3325         assert!(failed_htlcs.contains(&first_payment_hash.0));
3326         assert!(failed_htlcs.contains(&second_payment_hash.0));
3327         assert!(failed_htlcs.contains(&third_payment_hash.0));
3328 }
3329
3330 #[test]
3331 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3332         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3333         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3334         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3335         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3336 }
3337
3338 #[test]
3339 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3340         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3341         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3342         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3343         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3344 }
3345
3346 #[test]
3347 fn fail_backward_pending_htlc_upon_channel_failure() {
3348         let chanmon_cfgs = create_chanmon_cfgs(2);
3349         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3350         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3351         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3352         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3353         let logger = test_utils::TestLogger::new();
3354
3355         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3356         {
3357                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3358                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3359                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3360                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3361                 check_added_monitors!(nodes[0], 1);
3362
3363                 let payment_event = {
3364                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3365                         assert_eq!(events.len(), 1);
3366                         SendEvent::from_event(events.remove(0))
3367                 };
3368                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3369                 assert_eq!(payment_event.msgs.len(), 1);
3370         }
3371
3372         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3373         let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3374         {
3375                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3376                 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();
3377                 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3378                 check_added_monitors!(nodes[0], 0);
3379
3380                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3381         }
3382
3383         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3384         {
3385                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3386
3387                 let secp_ctx = Secp256k1::new();
3388                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3389                 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3390                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3391                 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();
3392                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height).unwrap();
3393                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3394                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3395
3396                 // Send a 0-msat update_add_htlc to fail the channel.
3397                 let update_add_htlc = msgs::UpdateAddHTLC {
3398                         channel_id: chan.2,
3399                         htlc_id: 0,
3400                         amount_msat: 0,
3401                         payment_hash,
3402                         cltv_expiry,
3403                         onion_routing_packet,
3404                 };
3405                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3406         }
3407
3408         // Check that Alice fails backward the pending HTLC from the second payment.
3409         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3410         check_closed_broadcast!(nodes[0], true);
3411         check_added_monitors!(nodes[0], 1);
3412 }
3413
3414 #[test]
3415 fn test_htlc_ignore_latest_remote_commitment() {
3416         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3417         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3418         let chanmon_cfgs = create_chanmon_cfgs(2);
3419         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3420         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3421         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3422         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3423
3424         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3425         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3426         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3427         check_closed_broadcast!(nodes[0], true);
3428         check_added_monitors!(nodes[0], 1);
3429
3430         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3431         assert_eq!(node_txn.len(), 3);
3432         assert_eq!(node_txn[0], node_txn[1]);
3433
3434         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3435         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3436         check_closed_broadcast!(nodes[1], true);
3437         check_added_monitors!(nodes[1], 1);
3438
3439         // Duplicate the connect_block call since this may happen due to other listeners
3440         // registering new transactions
3441         header.prev_blockhash = header.block_hash();
3442         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3443 }
3444
3445 #[test]
3446 fn test_force_close_fail_back() {
3447         // Check which HTLCs are failed-backwards on channel force-closure
3448         let chanmon_cfgs = create_chanmon_cfgs(3);
3449         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3450         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3451         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3452         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3453         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3454         let logger = test_utils::TestLogger::new();
3455
3456         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3457
3458         let mut payment_event = {
3459                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3460                 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();
3461                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3462                 check_added_monitors!(nodes[0], 1);
3463
3464                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3465                 assert_eq!(events.len(), 1);
3466                 SendEvent::from_event(events.remove(0))
3467         };
3468
3469         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3470         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3471
3472         expect_pending_htlcs_forwardable!(nodes[1]);
3473
3474         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3475         assert_eq!(events_2.len(), 1);
3476         payment_event = SendEvent::from_event(events_2.remove(0));
3477         assert_eq!(payment_event.msgs.len(), 1);
3478
3479         check_added_monitors!(nodes[1], 1);
3480         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3481         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3482         check_added_monitors!(nodes[2], 1);
3483         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3484
3485         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3486         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3487         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3488
3489         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3490         check_closed_broadcast!(nodes[2], true);
3491         check_added_monitors!(nodes[2], 1);
3492         let tx = {
3493                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3494                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3495                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3496                 // back to nodes[1] upon timeout otherwise.
3497                 assert_eq!(node_txn.len(), 1);
3498                 node_txn.remove(0)
3499         };
3500
3501         mine_transaction(&nodes[1], &tx);
3502
3503         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3504         check_closed_broadcast!(nodes[1], true);
3505         check_added_monitors!(nodes[1], 1);
3506
3507         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3508         {
3509                 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3510                 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3511                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3512         }
3513         mine_transaction(&nodes[2], &tx);
3514         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3515         assert_eq!(node_txn.len(), 1);
3516         assert_eq!(node_txn[0].input.len(), 1);
3517         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3518         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3519         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3520
3521         check_spends!(node_txn[0], tx);
3522 }
3523
3524 #[test]
3525 fn test_dup_events_on_peer_disconnect() {
3526         // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3527         // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3528         // as we used to generate the event immediately upon receipt of the payment preimage in the
3529         // update_fulfill_htlc message.
3530
3531         let chanmon_cfgs = create_chanmon_cfgs(2);
3532         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3533         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3534         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3535         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3536
3537         let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3538
3539         assert!(nodes[1].node.claim_funds(payment_preimage));
3540         check_added_monitors!(nodes[1], 1);
3541         let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3542         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3543         expect_payment_sent!(nodes[0], payment_preimage);
3544
3545         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3546         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3547
3548         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3549         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3550 }
3551
3552 #[test]
3553 fn test_simple_peer_disconnect() {
3554         // Test that we can reconnect when there are no lost messages
3555         let chanmon_cfgs = create_chanmon_cfgs(3);
3556         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3557         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3558         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3559         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3560         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3561
3562         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3563         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3564         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3565
3566         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3567         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3568         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3569         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3570
3571         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3572         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3573         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3574
3575         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3576         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3577         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3578         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3579
3580         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3581         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3582
3583         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3584         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3585
3586         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3587         {
3588                 let events = nodes[0].node.get_and_clear_pending_events();
3589                 assert_eq!(events.len(), 2);
3590                 match events[0] {
3591                         Event::PaymentSent { payment_preimage } => {
3592                                 assert_eq!(payment_preimage, payment_preimage_3);
3593                         },
3594                         _ => panic!("Unexpected event"),
3595                 }
3596                 match events[1] {
3597                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3598                                 assert_eq!(payment_hash, payment_hash_5);
3599                                 assert!(rejected_by_dest);
3600                         },
3601                         _ => panic!("Unexpected event"),
3602                 }
3603         }
3604
3605         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3606         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3607 }
3608
3609 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3610         // Test that we can reconnect when in-flight HTLC updates get dropped
3611         let chanmon_cfgs = create_chanmon_cfgs(2);
3612         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3613         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3614         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3615         if messages_delivered == 0 {
3616                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3617                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3618         } else {
3619                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3620         }
3621
3622         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3623
3624         let logger = test_utils::TestLogger::new();
3625         let payment_event = {
3626                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3627                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3628                         &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3629                         &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3630                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3631                 check_added_monitors!(nodes[0], 1);
3632
3633                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3634                 assert_eq!(events.len(), 1);
3635                 SendEvent::from_event(events.remove(0))
3636         };
3637         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3638
3639         if messages_delivered < 2 {
3640                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3641         } else {
3642                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3643                 if messages_delivered >= 3 {
3644                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3645                         check_added_monitors!(nodes[1], 1);
3646                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3647
3648                         if messages_delivered >= 4 {
3649                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3650                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3651                                 check_added_monitors!(nodes[0], 1);
3652
3653                                 if messages_delivered >= 5 {
3654                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3655                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3656                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3657                                         check_added_monitors!(nodes[0], 1);
3658
3659                                         if messages_delivered >= 6 {
3660                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3661                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3662                                                 check_added_monitors!(nodes[1], 1);
3663                                         }
3664                                 }
3665                         }
3666                 }
3667         }
3668
3669         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3670         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3671         if messages_delivered < 3 {
3672                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3673                 // received on either side, both sides will need to resend them.
3674                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3675         } else if messages_delivered == 3 {
3676                 // nodes[0] still wants its RAA + commitment_signed
3677                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3678         } else if messages_delivered == 4 {
3679                 // nodes[0] still wants its commitment_signed
3680                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3681         } else if messages_delivered == 5 {
3682                 // nodes[1] still wants its final RAA
3683                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3684         } else if messages_delivered == 6 {
3685                 // Everything was delivered...
3686                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3687         }
3688
3689         let events_1 = nodes[1].node.get_and_clear_pending_events();
3690         assert_eq!(events_1.len(), 1);
3691         match events_1[0] {
3692                 Event::PendingHTLCsForwardable { .. } => { },
3693                 _ => panic!("Unexpected event"),
3694         };
3695
3696         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3697         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3698         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3699
3700         nodes[1].node.process_pending_htlc_forwards();
3701
3702         let events_2 = nodes[1].node.get_and_clear_pending_events();
3703         assert_eq!(events_2.len(), 1);
3704         match events_2[0] {
3705                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
3706                         assert_eq!(payment_hash_1, *payment_hash);
3707                         assert!(payment_preimage.is_none());
3708                         assert_eq!(payment_secret_1, *payment_secret);
3709                         assert_eq!(amt, 1000000);
3710                 },
3711                 _ => panic!("Unexpected event"),
3712         }
3713
3714         nodes[1].node.claim_funds(payment_preimage_1);
3715         check_added_monitors!(nodes[1], 1);
3716
3717         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3718         assert_eq!(events_3.len(), 1);
3719         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3720                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3721                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3722                         assert!(updates.update_add_htlcs.is_empty());
3723                         assert!(updates.update_fail_htlcs.is_empty());
3724                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3725                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3726                         assert!(updates.update_fee.is_none());
3727                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3728                 },
3729                 _ => panic!("Unexpected event"),
3730         };
3731
3732         if messages_delivered >= 1 {
3733                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3734
3735                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3736                 assert_eq!(events_4.len(), 1);
3737                 match events_4[0] {
3738                         Event::PaymentSent { ref payment_preimage } => {
3739                                 assert_eq!(payment_preimage_1, *payment_preimage);
3740                         },
3741                         _ => panic!("Unexpected event"),
3742                 }
3743
3744                 if messages_delivered >= 2 {
3745                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3746                         check_added_monitors!(nodes[0], 1);
3747                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3748
3749                         if messages_delivered >= 3 {
3750                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3751                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3752                                 check_added_monitors!(nodes[1], 1);
3753
3754                                 if messages_delivered >= 4 {
3755                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3756                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3757                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3758                                         check_added_monitors!(nodes[1], 1);
3759
3760                                         if messages_delivered >= 5 {
3761                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3762                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3763                                                 check_added_monitors!(nodes[0], 1);
3764                                         }
3765                                 }
3766                         }
3767                 }
3768         }
3769
3770         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3771         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3772         if messages_delivered < 2 {
3773                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3774                 if messages_delivered < 1 {
3775                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3776                         assert_eq!(events_4.len(), 1);
3777                         match events_4[0] {
3778                                 Event::PaymentSent { ref payment_preimage } => {
3779                                         assert_eq!(payment_preimage_1, *payment_preimage);
3780                                 },
3781                                 _ => panic!("Unexpected event"),
3782                         }
3783                 } else {
3784                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3785                 }
3786         } else if messages_delivered == 2 {
3787                 // nodes[0] still wants its RAA + commitment_signed
3788                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3789         } else if messages_delivered == 3 {
3790                 // nodes[0] still wants its commitment_signed
3791                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3792         } else if messages_delivered == 4 {
3793                 // nodes[1] still wants its final RAA
3794                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3795         } else if messages_delivered == 5 {
3796                 // Everything was delivered...
3797                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3798         }
3799
3800         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3801         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3802         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3803
3804         // Channel should still work fine...
3805         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3806         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3807                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3808                 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3809         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3810         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3811 }
3812
3813 #[test]
3814 fn test_drop_messages_peer_disconnect_a() {
3815         do_test_drop_messages_peer_disconnect(0);
3816         do_test_drop_messages_peer_disconnect(1);
3817         do_test_drop_messages_peer_disconnect(2);
3818         do_test_drop_messages_peer_disconnect(3);
3819 }
3820
3821 #[test]
3822 fn test_drop_messages_peer_disconnect_b() {
3823         do_test_drop_messages_peer_disconnect(4);
3824         do_test_drop_messages_peer_disconnect(5);
3825         do_test_drop_messages_peer_disconnect(6);
3826 }
3827
3828 #[test]
3829 fn test_funding_peer_disconnect() {
3830         // Test that we can lock in our funding tx while disconnected
3831         let chanmon_cfgs = create_chanmon_cfgs(2);
3832         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3833         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3834         let persister: test_utils::TestPersister;
3835         let new_chain_monitor: test_utils::TestChainMonitor;
3836         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3837         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3838         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3839
3840         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3841         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3842
3843         confirm_transaction(&nodes[0], &tx);
3844         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3845         assert_eq!(events_1.len(), 1);
3846         match events_1[0] {
3847                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3848                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3849                 },
3850                 _ => panic!("Unexpected event"),
3851         }
3852
3853         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3854
3855         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3856         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3857
3858         confirm_transaction(&nodes[1], &tx);
3859         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3860         assert_eq!(events_2.len(), 2);
3861         let funding_locked = match events_2[0] {
3862                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3863                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3864                         msg.clone()
3865                 },
3866                 _ => panic!("Unexpected event"),
3867         };
3868         let bs_announcement_sigs = match events_2[1] {
3869                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3870                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3871                         msg.clone()
3872                 },
3873                 _ => panic!("Unexpected event"),
3874         };
3875
3876         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3877
3878         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3879         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3880         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3881         assert_eq!(events_3.len(), 2);
3882         let as_announcement_sigs = match events_3[0] {
3883                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3884                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3885                         msg.clone()
3886                 },
3887                 _ => panic!("Unexpected event"),
3888         };
3889         let (as_announcement, as_update) = match events_3[1] {
3890                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3891                         (msg.clone(), update_msg.clone())
3892                 },
3893                 _ => panic!("Unexpected event"),
3894         };
3895
3896         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3897         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3898         assert_eq!(events_4.len(), 1);
3899         let (_, bs_update) = match events_4[0] {
3900                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3901                         (msg.clone(), update_msg.clone())
3902                 },
3903                 _ => panic!("Unexpected event"),
3904         };
3905
3906         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3907         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3908         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3909
3910         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3911         let logger = test_utils::TestLogger::new();
3912         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();
3913         let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3914         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3915
3916         // Check that after deserialization and reconnection we can still generate an identical
3917         // channel_announcement from the cached signatures.
3918         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3919
3920         let nodes_0_serialized = nodes[0].node.encode();
3921         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3922         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3923
3924         persister = test_utils::TestPersister::new();
3925         let keys_manager = &chanmon_cfgs[0].keys_manager;
3926         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);
3927         nodes[0].chain_monitor = &new_chain_monitor;
3928         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3929         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3930                 &mut chan_0_monitor_read, keys_manager).unwrap();
3931         assert!(chan_0_monitor_read.is_empty());
3932
3933         let mut nodes_0_read = &nodes_0_serialized[..];
3934         let (_, nodes_0_deserialized_tmp) = {
3935                 let mut channel_monitors = HashMap::new();
3936                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3937                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3938                         default_config: UserConfig::default(),
3939                         keys_manager,
3940                         fee_estimator: node_cfgs[0].fee_estimator,
3941                         chain_monitor: nodes[0].chain_monitor,
3942                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3943                         logger: nodes[0].logger,
3944                         channel_monitors,
3945                 }).unwrap()
3946         };
3947         nodes_0_deserialized = nodes_0_deserialized_tmp;
3948         assert!(nodes_0_read.is_empty());
3949
3950         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
3951         nodes[0].node = &nodes_0_deserialized;
3952         check_added_monitors!(nodes[0], 1);
3953
3954         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3955
3956         // as_announcement should be re-generated exactly by broadcast_node_announcement.
3957         nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
3958         let msgs = nodes[0].node.get_and_clear_pending_msg_events();
3959         let mut found_announcement = false;
3960         for event in msgs.iter() {
3961                 match event {
3962                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
3963                                 if *msg == as_announcement { found_announcement = true; }
3964                         },
3965                         MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
3966                         _ => panic!("Unexpected event"),
3967                 }
3968         }
3969         assert!(found_announcement);
3970 }
3971
3972 #[test]
3973 fn test_drop_messages_peer_disconnect_dual_htlc() {
3974         // Test that we can handle reconnecting when both sides of a channel have pending
3975         // commitment_updates when we disconnect.
3976         let chanmon_cfgs = create_chanmon_cfgs(2);
3977         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3978         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3979         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3980         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3981         let logger = test_utils::TestLogger::new();
3982
3983         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3984
3985         // Now try to send a second payment which will fail to send
3986         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
3987         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3988         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();
3989         nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
3990         check_added_monitors!(nodes[0], 1);
3991
3992         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3993         assert_eq!(events_1.len(), 1);
3994         match events_1[0] {
3995                 MessageSendEvent::UpdateHTLCs { .. } => {},
3996                 _ => panic!("Unexpected event"),
3997         }
3998
3999         assert!(nodes[1].node.claim_funds(payment_preimage_1));
4000         check_added_monitors!(nodes[1], 1);
4001
4002         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
4003         assert_eq!(events_2.len(), 1);
4004         match events_2[0] {
4005                 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 } } => {
4006                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4007                         assert!(update_add_htlcs.is_empty());
4008                         assert_eq!(update_fulfill_htlcs.len(), 1);
4009                         assert!(update_fail_htlcs.is_empty());
4010                         assert!(update_fail_malformed_htlcs.is_empty());
4011                         assert!(update_fee.is_none());
4012
4013                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
4014                         let events_3 = nodes[0].node.get_and_clear_pending_events();
4015                         assert_eq!(events_3.len(), 1);
4016                         match events_3[0] {
4017                                 Event::PaymentSent { ref payment_preimage } => {
4018                                         assert_eq!(*payment_preimage, payment_preimage_1);
4019                                 },
4020                                 _ => panic!("Unexpected event"),
4021                         }
4022
4023                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
4024                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4025                         // No commitment_signed so get_event_msg's assert(len == 1) passes
4026                         check_added_monitors!(nodes[0], 1);
4027                 },
4028                 _ => panic!("Unexpected event"),
4029         }
4030
4031         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4032         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4033
4034         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4035         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4036         assert_eq!(reestablish_1.len(), 1);
4037         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4038         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4039         assert_eq!(reestablish_2.len(), 1);
4040
4041         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4042         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4043         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4044         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4045
4046         assert!(as_resp.0.is_none());
4047         assert!(bs_resp.0.is_none());
4048
4049         assert!(bs_resp.1.is_none());
4050         assert!(bs_resp.2.is_none());
4051
4052         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4053
4054         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
4055         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
4056         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4057         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4058         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
4059         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
4060         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
4061         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4062         // No commitment_signed so get_event_msg's assert(len == 1) passes
4063         check_added_monitors!(nodes[1], 1);
4064
4065         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
4066         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4067         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4068         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4069         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4070         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4071         assert!(bs_second_commitment_signed.update_fee.is_none());
4072         check_added_monitors!(nodes[1], 1);
4073
4074         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4075         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4076         assert!(as_commitment_signed.update_add_htlcs.is_empty());
4077         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4078         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4079         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4080         assert!(as_commitment_signed.update_fee.is_none());
4081         check_added_monitors!(nodes[0], 1);
4082
4083         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4084         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4085         // No commitment_signed so get_event_msg's assert(len == 1) passes
4086         check_added_monitors!(nodes[0], 1);
4087
4088         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4089         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4090         // No commitment_signed so get_event_msg's assert(len == 1) passes
4091         check_added_monitors!(nodes[1], 1);
4092
4093         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4094         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4095         check_added_monitors!(nodes[1], 1);
4096
4097         expect_pending_htlcs_forwardable!(nodes[1]);
4098
4099         let events_5 = nodes[1].node.get_and_clear_pending_events();
4100         assert_eq!(events_5.len(), 1);
4101         match events_5[0] {
4102                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt: _, user_payment_id: _ } => {
4103                         assert_eq!(payment_hash_2, *payment_hash);
4104                         assert!(payment_preimage.is_none());
4105                         assert_eq!(payment_secret_2, *payment_secret);
4106                 },
4107                 _ => panic!("Unexpected event"),
4108         }
4109
4110         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4111         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4112         check_added_monitors!(nodes[0], 1);
4113
4114         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4115 }
4116
4117 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4118         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4119         // to avoid our counterparty failing the channel.
4120         let chanmon_cfgs = create_chanmon_cfgs(2);
4121         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4122         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4123         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4124
4125         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4126         let logger = test_utils::TestLogger::new();
4127
4128         let our_payment_hash = if send_partial_mpp {
4129                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4130                 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();
4131                 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
4132                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4133                 // indicates there are more HTLCs coming.
4134                 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.
4135                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height).unwrap();
4136                 check_added_monitors!(nodes[0], 1);
4137                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4138                 assert_eq!(events.len(), 1);
4139                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4140                 // hop should *not* yet generate any PaymentReceived event(s).
4141                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, payment_secret, events.drain(..).next().unwrap(), false);
4142                 our_payment_hash
4143         } else {
4144                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4145         };
4146
4147         let mut block = Block {
4148                 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4149                 txdata: vec![],
4150         };
4151         connect_block(&nodes[0], &block);
4152         connect_block(&nodes[1], &block);
4153         let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
4154         for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
4155                 block.header.prev_blockhash = block.block_hash();
4156                 connect_block(&nodes[0], &block);
4157                 connect_block(&nodes[1], &block);
4158         }
4159
4160         expect_pending_htlcs_forwardable!(nodes[1]);
4161
4162         check_added_monitors!(nodes[1], 1);
4163         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4164         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4165         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4166         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4167         assert!(htlc_timeout_updates.update_fee.is_none());
4168
4169         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4170         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4171         // 100_000 msat as u64, followed by the height at which we failed back above
4172         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4173         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4174         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4175 }
4176
4177 #[test]
4178 fn test_htlc_timeout() {
4179         do_test_htlc_timeout(true);
4180         do_test_htlc_timeout(false);
4181 }
4182
4183 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4184         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4185         let chanmon_cfgs = create_chanmon_cfgs(3);
4186         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4187         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4188         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4189         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4190         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4191
4192         // Make sure all nodes are at the same starting height
4193         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4194         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4195         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4196
4197         let logger = test_utils::TestLogger::new();
4198
4199         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4200         let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4201         {
4202                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4203                 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();
4204                 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4205         }
4206         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4207         check_added_monitors!(nodes[1], 1);
4208
4209         // Now attempt to route a second payment, which should be placed in the holding cell
4210         let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4211         if forwarded_htlc {
4212                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4213                 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();
4214                 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4215                 check_added_monitors!(nodes[0], 1);
4216                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4217                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4218                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4219                 expect_pending_htlcs_forwardable!(nodes[1]);
4220                 check_added_monitors!(nodes[1], 0);
4221         } else {
4222                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4223                 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();
4224                 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4225                 check_added_monitors!(nodes[1], 0);
4226         }
4227
4228         connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4229         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4230         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4231         connect_blocks(&nodes[1], 1);
4232
4233         if forwarded_htlc {
4234                 expect_pending_htlcs_forwardable!(nodes[1]);
4235                 check_added_monitors!(nodes[1], 1);
4236                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4237                 assert_eq!(fail_commit.len(), 1);
4238                 match fail_commit[0] {
4239                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4240                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4241                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4242                         },
4243                         _ => unreachable!(),
4244                 }
4245                 expect_payment_failed!(nodes[0], second_payment_hash, false);
4246                 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4247                         match update {
4248                                 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4249                                 _ => panic!("Unexpected event"),
4250                         }
4251                 } else {
4252                         panic!("Unexpected event");
4253                 }
4254         } else {
4255                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4256         }
4257 }
4258
4259 #[test]
4260 fn test_holding_cell_htlc_add_timeouts() {
4261         do_test_holding_cell_htlc_add_timeouts(false);
4262         do_test_holding_cell_htlc_add_timeouts(true);
4263 }
4264
4265 #[test]
4266 fn test_invalid_channel_announcement() {
4267         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4268         let secp_ctx = Secp256k1::new();
4269         let chanmon_cfgs = create_chanmon_cfgs(2);
4270         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4271         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4272         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4273
4274         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4275
4276         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4277         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4278         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4279         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4280
4281         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 } );
4282
4283         let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4284         let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4285
4286         let as_network_key = nodes[0].node.get_our_node_id();
4287         let bs_network_key = nodes[1].node.get_our_node_id();
4288
4289         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4290
4291         let mut chan_announcement;
4292
4293         macro_rules! dummy_unsigned_msg {
4294                 () => {
4295                         msgs::UnsignedChannelAnnouncement {
4296                                 features: ChannelFeatures::known(),
4297                                 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4298                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4299                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4300                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4301                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4302                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4303                                 excess_data: Vec::new(),
4304                         };
4305                 }
4306         }
4307
4308         macro_rules! sign_msg {
4309                 ($unsigned_msg: expr) => {
4310                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4311                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4312                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4313                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4314                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4315                         chan_announcement = msgs::ChannelAnnouncement {
4316                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4317                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4318                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4319                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4320                                 contents: $unsigned_msg
4321                         }
4322                 }
4323         }
4324
4325         let unsigned_msg = dummy_unsigned_msg!();
4326         sign_msg!(unsigned_msg);
4327         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4328         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 } );
4329
4330         // Configured with Network::Testnet
4331         let mut unsigned_msg = dummy_unsigned_msg!();
4332         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4333         sign_msg!(unsigned_msg);
4334         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4335
4336         let mut unsigned_msg = dummy_unsigned_msg!();
4337         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4338         sign_msg!(unsigned_msg);
4339         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4340 }
4341
4342 #[test]
4343 fn test_no_txn_manager_serialize_deserialize() {
4344         let chanmon_cfgs = create_chanmon_cfgs(2);
4345         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4346         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4347         let logger: test_utils::TestLogger;
4348         let fee_estimator: test_utils::TestFeeEstimator;
4349         let persister: test_utils::TestPersister;
4350         let new_chain_monitor: test_utils::TestChainMonitor;
4351         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4352         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4353
4354         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4355
4356         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4357
4358         let nodes_0_serialized = nodes[0].node.encode();
4359         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4360         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4361
4362         logger = test_utils::TestLogger::new();
4363         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4364         persister = test_utils::TestPersister::new();
4365         let keys_manager = &chanmon_cfgs[0].keys_manager;
4366         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4367         nodes[0].chain_monitor = &new_chain_monitor;
4368         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4369         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4370                 &mut chan_0_monitor_read, keys_manager).unwrap();
4371         assert!(chan_0_monitor_read.is_empty());
4372
4373         let mut nodes_0_read = &nodes_0_serialized[..];
4374         let config = UserConfig::default();
4375         let (_, nodes_0_deserialized_tmp) = {
4376                 let mut channel_monitors = HashMap::new();
4377                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4378                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4379                         default_config: config,
4380                         keys_manager,
4381                         fee_estimator: &fee_estimator,
4382                         chain_monitor: nodes[0].chain_monitor,
4383                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4384                         logger: &logger,
4385                         channel_monitors,
4386                 }).unwrap()
4387         };
4388         nodes_0_deserialized = nodes_0_deserialized_tmp;
4389         assert!(nodes_0_read.is_empty());
4390
4391         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4392         nodes[0].node = &nodes_0_deserialized;
4393         assert_eq!(nodes[0].node.list_channels().len(), 1);
4394         check_added_monitors!(nodes[0], 1);
4395
4396         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4397         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4398         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4399         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4400
4401         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4402         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4403         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4404         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4405
4406         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4407         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4408         for node in nodes.iter() {
4409                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4410                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4411                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4412         }
4413
4414         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4415 }
4416
4417 #[test]
4418 fn test_dup_htlc_onchain_fails_on_reload() {
4419         // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4420         // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4421         // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4422         // the ChannelMonitor tells it to.
4423         //
4424         // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4425         // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4426         // PaymentFailed event appearing). However, because we may not serialize the relevant
4427         // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4428         // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4429         // and de-duplicates ChannelMonitor events.
4430         //
4431         // This tests that explicit tracking behavior.
4432         let chanmon_cfgs = create_chanmon_cfgs(2);
4433         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4434         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4435         let persister: test_utils::TestPersister;
4436         let new_chain_monitor: test_utils::TestChainMonitor;
4437         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4438         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4439
4440         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4441
4442         // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4443         // nodes[0].
4444         let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4445         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4446         check_closed_broadcast!(nodes[0], true);
4447         check_added_monitors!(nodes[0], 1);
4448
4449         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4450         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4451
4452         // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
4453         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
4454         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4455         assert_eq!(node_txn.len(), 3);
4456         assert_eq!(node_txn[0], node_txn[1]);
4457
4458         assert!(nodes[1].node.claim_funds(payment_preimage));
4459         check_added_monitors!(nodes[1], 1);
4460
4461         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4462         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4463         check_closed_broadcast!(nodes[1], true);
4464         check_added_monitors!(nodes[1], 1);
4465         let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4466
4467         header.prev_blockhash = nodes[0].best_block_hash();
4468         connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4469
4470         // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4471         // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4472         // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4473         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4474         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4475
4476         header.prev_blockhash = nodes[0].best_block_hash();
4477         let claim_block = Block { header, txdata: claim_txn};
4478         connect_block(&nodes[0], &claim_block);
4479         expect_payment_sent!(nodes[0], payment_preimage);
4480
4481         // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4482         // connected a highly-relevant block, it likely gets serialized out now.
4483         let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4484         nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4485
4486         // Now reload nodes[0]...
4487         persister = test_utils::TestPersister::new();
4488         let keys_manager = &chanmon_cfgs[0].keys_manager;
4489         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);
4490         nodes[0].chain_monitor = &new_chain_monitor;
4491         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4492         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4493                 &mut chan_0_monitor_read, keys_manager).unwrap();
4494         assert!(chan_0_monitor_read.is_empty());
4495
4496         let (_, nodes_0_deserialized_tmp) = {
4497                 let mut channel_monitors = HashMap::new();
4498                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4499                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4500                         ::read(&mut std::io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4501                                 default_config: Default::default(),
4502                                 keys_manager,
4503                                 fee_estimator: node_cfgs[0].fee_estimator,
4504                                 chain_monitor: nodes[0].chain_monitor,
4505                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4506                                 logger: nodes[0].logger,
4507                                 channel_monitors,
4508                         }).unwrap()
4509         };
4510         nodes_0_deserialized = nodes_0_deserialized_tmp;
4511
4512         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4513         check_added_monitors!(nodes[0], 1);
4514         nodes[0].node = &nodes_0_deserialized;
4515
4516         // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4517         // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4518         // payment events should kick in, leaving us with no pending events here.
4519         let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
4520         nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
4521         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4522 }
4523
4524 #[test]
4525 fn test_manager_serialize_deserialize_events() {
4526         // This test makes sure the events field in ChannelManager survives de/serialization
4527         let chanmon_cfgs = create_chanmon_cfgs(2);
4528         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4529         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4530         let fee_estimator: test_utils::TestFeeEstimator;
4531         let persister: test_utils::TestPersister;
4532         let logger: test_utils::TestLogger;
4533         let new_chain_monitor: test_utils::TestChainMonitor;
4534         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4535         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4536
4537         // Start creating a channel, but stop right before broadcasting the funding transaction
4538         let channel_value = 100000;
4539         let push_msat = 10001;
4540         let a_flags = InitFeatures::known();
4541         let b_flags = InitFeatures::known();
4542         let node_a = nodes.remove(0);
4543         let node_b = nodes.remove(0);
4544         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4545         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()));
4546         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()));
4547
4548         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4549
4550         node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4551         check_added_monitors!(node_a, 0);
4552
4553         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()));
4554         {
4555                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4556                 assert_eq!(added_monitors.len(), 1);
4557                 assert_eq!(added_monitors[0].0, funding_output);
4558                 added_monitors.clear();
4559         }
4560
4561         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()));
4562         {
4563                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4564                 assert_eq!(added_monitors.len(), 1);
4565                 assert_eq!(added_monitors[0].0, funding_output);
4566                 added_monitors.clear();
4567         }
4568         // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4569
4570         nodes.push(node_a);
4571         nodes.push(node_b);
4572
4573         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4574         let nodes_0_serialized = nodes[0].node.encode();
4575         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4576         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4577
4578         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4579         logger = test_utils::TestLogger::new();
4580         persister = test_utils::TestPersister::new();
4581         let keys_manager = &chanmon_cfgs[0].keys_manager;
4582         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4583         nodes[0].chain_monitor = &new_chain_monitor;
4584         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4585         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4586                 &mut chan_0_monitor_read, keys_manager).unwrap();
4587         assert!(chan_0_monitor_read.is_empty());
4588
4589         let mut nodes_0_read = &nodes_0_serialized[..];
4590         let config = UserConfig::default();
4591         let (_, nodes_0_deserialized_tmp) = {
4592                 let mut channel_monitors = HashMap::new();
4593                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4594                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4595                         default_config: config,
4596                         keys_manager,
4597                         fee_estimator: &fee_estimator,
4598                         chain_monitor: nodes[0].chain_monitor,
4599                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4600                         logger: &logger,
4601                         channel_monitors,
4602                 }).unwrap()
4603         };
4604         nodes_0_deserialized = nodes_0_deserialized_tmp;
4605         assert!(nodes_0_read.is_empty());
4606
4607         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4608
4609         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4610         nodes[0].node = &nodes_0_deserialized;
4611
4612         // After deserializing, make sure the funding_transaction is still held by the channel manager
4613         let events_4 = nodes[0].node.get_and_clear_pending_events();
4614         assert_eq!(events_4.len(), 0);
4615         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4616         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4617
4618         // Make sure the channel is functioning as though the de/serialization never happened
4619         assert_eq!(nodes[0].node.list_channels().len(), 1);
4620         check_added_monitors!(nodes[0], 1);
4621
4622         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4623         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4624         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4625         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4626
4627         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4628         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4629         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4630         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4631
4632         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4633         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4634         for node in nodes.iter() {
4635                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4636                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4637                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4638         }
4639
4640         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4641 }
4642
4643 #[test]
4644 fn test_simple_manager_serialize_deserialize() {
4645         let chanmon_cfgs = create_chanmon_cfgs(2);
4646         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4647         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4648         let logger: test_utils::TestLogger;
4649         let fee_estimator: test_utils::TestFeeEstimator;
4650         let persister: test_utils::TestPersister;
4651         let new_chain_monitor: test_utils::TestChainMonitor;
4652         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4653         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4654         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4655
4656         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4657         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4658
4659         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4660
4661         let nodes_0_serialized = nodes[0].node.encode();
4662         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4663         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4664
4665         logger = test_utils::TestLogger::new();
4666         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4667         persister = test_utils::TestPersister::new();
4668         let keys_manager = &chanmon_cfgs[0].keys_manager;
4669         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4670         nodes[0].chain_monitor = &new_chain_monitor;
4671         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4672         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4673                 &mut chan_0_monitor_read, keys_manager).unwrap();
4674         assert!(chan_0_monitor_read.is_empty());
4675
4676         let mut nodes_0_read = &nodes_0_serialized[..];
4677         let (_, nodes_0_deserialized_tmp) = {
4678                 let mut channel_monitors = HashMap::new();
4679                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4680                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4681                         default_config: UserConfig::default(),
4682                         keys_manager,
4683                         fee_estimator: &fee_estimator,
4684                         chain_monitor: nodes[0].chain_monitor,
4685                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4686                         logger: &logger,
4687                         channel_monitors,
4688                 }).unwrap()
4689         };
4690         nodes_0_deserialized = nodes_0_deserialized_tmp;
4691         assert!(nodes_0_read.is_empty());
4692
4693         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4694         nodes[0].node = &nodes_0_deserialized;
4695         check_added_monitors!(nodes[0], 1);
4696
4697         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4698
4699         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4700         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4701 }
4702
4703 #[test]
4704 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4705         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4706         let chanmon_cfgs = create_chanmon_cfgs(4);
4707         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4708         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4709         let logger: test_utils::TestLogger;
4710         let fee_estimator: test_utils::TestFeeEstimator;
4711         let persister: test_utils::TestPersister;
4712         let new_chain_monitor: test_utils::TestChainMonitor;
4713         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4714         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4715         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4716         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4717         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4718
4719         let mut node_0_stale_monitors_serialized = Vec::new();
4720         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4721                 let mut writer = test_utils::TestVecWriter(Vec::new());
4722                 monitor.1.write(&mut writer).unwrap();
4723                 node_0_stale_monitors_serialized.push(writer.0);
4724         }
4725
4726         let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4727
4728         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4729         let nodes_0_serialized = nodes[0].node.encode();
4730
4731         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4732         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4733         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4734         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4735
4736         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4737         // nodes[3])
4738         let mut node_0_monitors_serialized = Vec::new();
4739         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4740                 let mut writer = test_utils::TestVecWriter(Vec::new());
4741                 monitor.1.write(&mut writer).unwrap();
4742                 node_0_monitors_serialized.push(writer.0);
4743         }
4744
4745         logger = test_utils::TestLogger::new();
4746         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4747         persister = test_utils::TestPersister::new();
4748         let keys_manager = &chanmon_cfgs[0].keys_manager;
4749         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4750         nodes[0].chain_monitor = &new_chain_monitor;
4751
4752
4753         let mut node_0_stale_monitors = Vec::new();
4754         for serialized in node_0_stale_monitors_serialized.iter() {
4755                 let mut read = &serialized[..];
4756                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4757                 assert!(read.is_empty());
4758                 node_0_stale_monitors.push(monitor);
4759         }
4760
4761         let mut node_0_monitors = Vec::new();
4762         for serialized in node_0_monitors_serialized.iter() {
4763                 let mut read = &serialized[..];
4764                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4765                 assert!(read.is_empty());
4766                 node_0_monitors.push(monitor);
4767         }
4768
4769         let mut nodes_0_read = &nodes_0_serialized[..];
4770         if let Err(msgs::DecodeError::InvalidValue) =
4771                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4772                 default_config: UserConfig::default(),
4773                 keys_manager,
4774                 fee_estimator: &fee_estimator,
4775                 chain_monitor: nodes[0].chain_monitor,
4776                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4777                 logger: &logger,
4778                 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4779         }) { } else {
4780                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4781         };
4782
4783         let mut nodes_0_read = &nodes_0_serialized[..];
4784         let (_, nodes_0_deserialized_tmp) =
4785                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4786                 default_config: UserConfig::default(),
4787                 keys_manager,
4788                 fee_estimator: &fee_estimator,
4789                 chain_monitor: nodes[0].chain_monitor,
4790                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4791                 logger: &logger,
4792                 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4793         }).unwrap();
4794         nodes_0_deserialized = nodes_0_deserialized_tmp;
4795         assert!(nodes_0_read.is_empty());
4796
4797         { // Channel close should result in a commitment tx
4798                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4799                 assert_eq!(txn.len(), 1);
4800                 check_spends!(txn[0], funding_tx);
4801                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4802         }
4803
4804         for monitor in node_0_monitors.drain(..) {
4805                 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4806                 check_added_monitors!(nodes[0], 1);
4807         }
4808         nodes[0].node = &nodes_0_deserialized;
4809
4810         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4811         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4812         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4813         //... and we can even still claim the payment!
4814         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4815
4816         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4817         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4818         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4819         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4820         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4821         assert_eq!(msg_events.len(), 1);
4822         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4823                 match action {
4824                         &ErrorAction::SendErrorMessage { ref msg } => {
4825                                 assert_eq!(msg.channel_id, channel_id);
4826                         },
4827                         _ => panic!("Unexpected event!"),
4828                 }
4829         }
4830 }
4831
4832 macro_rules! check_spendable_outputs {
4833         ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4834                 {
4835                         let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4836                         let mut txn = Vec::new();
4837                         let mut all_outputs = Vec::new();
4838                         let secp_ctx = Secp256k1::new();
4839                         for event in events.drain(..) {
4840                                 match event {
4841                                         Event::SpendableOutputs { mut outputs } => {
4842                                                 for outp in outputs.drain(..) {
4843                                                         txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4844                                                         all_outputs.push(outp);
4845                                                 }
4846                                         },
4847                                         _ => panic!("Unexpected event"),
4848                                 };
4849                         }
4850                         if all_outputs.len() > 1 {
4851                                 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) {
4852                                         txn.push(tx);
4853                                 }
4854                         }
4855                         txn
4856                 }
4857         }
4858 }
4859
4860 #[test]
4861 fn test_claim_sizeable_push_msat() {
4862         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4863         let chanmon_cfgs = create_chanmon_cfgs(2);
4864         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4865         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4866         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4867
4868         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4869         nodes[1].node.force_close_channel(&chan.2).unwrap();
4870         check_closed_broadcast!(nodes[1], true);
4871         check_added_monitors!(nodes[1], 1);
4872         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4873         assert_eq!(node_txn.len(), 1);
4874         check_spends!(node_txn[0], chan.3);
4875         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
4876
4877         mine_transaction(&nodes[1], &node_txn[0]);
4878         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4879
4880         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4881         assert_eq!(spend_txn.len(), 1);
4882         check_spends!(spend_txn[0], node_txn[0]);
4883 }
4884
4885 #[test]
4886 fn test_claim_on_remote_sizeable_push_msat() {
4887         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4888         // to_remote output is encumbered by a P2WPKH
4889         let chanmon_cfgs = create_chanmon_cfgs(2);
4890         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4891         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4892         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4893
4894         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4895         nodes[0].node.force_close_channel(&chan.2).unwrap();
4896         check_closed_broadcast!(nodes[0], true);
4897         check_added_monitors!(nodes[0], 1);
4898
4899         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4900         assert_eq!(node_txn.len(), 1);
4901         check_spends!(node_txn[0], chan.3);
4902         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
4903
4904         mine_transaction(&nodes[1], &node_txn[0]);
4905         check_closed_broadcast!(nodes[1], true);
4906         check_added_monitors!(nodes[1], 1);
4907         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4908
4909         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4910         assert_eq!(spend_txn.len(), 1);
4911         check_spends!(spend_txn[0], node_txn[0]);
4912 }
4913
4914 #[test]
4915 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4916         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4917         // to_remote output is encumbered by a P2WPKH
4918
4919         let chanmon_cfgs = create_chanmon_cfgs(2);
4920         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4921         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4922         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4923
4924         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4925         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4926         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4927         assert_eq!(revoked_local_txn[0].input.len(), 1);
4928         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4929
4930         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4931         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4932         check_closed_broadcast!(nodes[1], true);
4933         check_added_monitors!(nodes[1], 1);
4934
4935         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4936         mine_transaction(&nodes[1], &node_txn[0]);
4937         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4938
4939         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4940         assert_eq!(spend_txn.len(), 3);
4941         check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4942         check_spends!(spend_txn[1], node_txn[0]);
4943         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4944 }
4945
4946 #[test]
4947 fn test_static_spendable_outputs_preimage_tx() {
4948         let chanmon_cfgs = create_chanmon_cfgs(2);
4949         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4950         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4951         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4952
4953         // Create some initial channels
4954         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4955
4956         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4957
4958         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4959         assert_eq!(commitment_tx[0].input.len(), 1);
4960         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4961
4962         // Settle A's commitment tx on B's chain
4963         assert!(nodes[1].node.claim_funds(payment_preimage));
4964         check_added_monitors!(nodes[1], 1);
4965         mine_transaction(&nodes[1], &commitment_tx[0]);
4966         check_added_monitors!(nodes[1], 1);
4967         let events = nodes[1].node.get_and_clear_pending_msg_events();
4968         match events[0] {
4969                 MessageSendEvent::UpdateHTLCs { .. } => {},
4970                 _ => panic!("Unexpected event"),
4971         }
4972         match events[1] {
4973                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4974                 _ => panic!("Unexepected event"),
4975         }
4976
4977         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4978         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4979         assert_eq!(node_txn.len(), 3);
4980         check_spends!(node_txn[0], commitment_tx[0]);
4981         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4982         check_spends!(node_txn[1], chan_1.3);
4983         check_spends!(node_txn[2], node_txn[1]);
4984
4985         mine_transaction(&nodes[1], &node_txn[0]);
4986         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4987
4988         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4989         assert_eq!(spend_txn.len(), 1);
4990         check_spends!(spend_txn[0], node_txn[0]);
4991 }
4992
4993 #[test]
4994 fn test_static_spendable_outputs_timeout_tx() {
4995         let chanmon_cfgs = create_chanmon_cfgs(2);
4996         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4997         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4998         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4999
5000         // Create some initial channels
5001         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5002
5003         // Rebalance the network a bit by relaying one payment through all the channels ...
5004         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5005
5006         let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
5007
5008         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5009         assert_eq!(commitment_tx[0].input.len(), 1);
5010         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
5011
5012         // Settle A's commitment tx on B' chain
5013         mine_transaction(&nodes[1], &commitment_tx[0]);
5014         check_added_monitors!(nodes[1], 1);
5015         let events = nodes[1].node.get_and_clear_pending_msg_events();
5016         match events[0] {
5017                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5018                 _ => panic!("Unexpected event"),
5019         }
5020         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5021
5022         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
5023         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
5024         assert_eq!(node_txn.len(), 2); // ChannelManager : 1 local commitent tx, ChannelMonitor: timeout tx
5025         check_spends!(node_txn[0], chan_1.3.clone());
5026         check_spends!(node_txn[1],  commitment_tx[0].clone());
5027         assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5028
5029         mine_transaction(&nodes[1], &node_txn[1]);
5030         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5031         expect_payment_failed!(nodes[1], our_payment_hash, true);
5032
5033         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5034         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
5035         check_spends!(spend_txn[0], commitment_tx[0]);
5036         check_spends!(spend_txn[1], node_txn[1]);
5037         check_spends!(spend_txn[2], node_txn[1], commitment_tx[0]); // All outputs
5038 }
5039
5040 #[test]
5041 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
5042         let chanmon_cfgs = create_chanmon_cfgs(2);
5043         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5044         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5045         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5046
5047         // Create some initial channels
5048         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5049
5050         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5051         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5052         assert_eq!(revoked_local_txn[0].input.len(), 1);
5053         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5054
5055         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5056
5057         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5058         check_closed_broadcast!(nodes[1], true);
5059         check_added_monitors!(nodes[1], 1);
5060
5061         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5062         assert_eq!(node_txn.len(), 2);
5063         assert_eq!(node_txn[0].input.len(), 2);
5064         check_spends!(node_txn[0], revoked_local_txn[0]);
5065
5066         mine_transaction(&nodes[1], &node_txn[0]);
5067         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5068
5069         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5070         assert_eq!(spend_txn.len(), 1);
5071         check_spends!(spend_txn[0], node_txn[0]);
5072 }
5073
5074 #[test]
5075 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5076         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5077         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
5078         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5079         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5080         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5081
5082         // Create some initial channels
5083         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5084
5085         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5086         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5087         assert_eq!(revoked_local_txn[0].input.len(), 1);
5088         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5089
5090         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5091
5092         // A will generate HTLC-Timeout from revoked commitment tx
5093         mine_transaction(&nodes[0], &revoked_local_txn[0]);
5094         check_closed_broadcast!(nodes[0], true);
5095         check_added_monitors!(nodes[0], 1);
5096         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5097
5098         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5099         assert_eq!(revoked_htlc_txn.len(), 2);
5100         check_spends!(revoked_htlc_txn[0], chan_1.3);
5101         assert_eq!(revoked_htlc_txn[1].input.len(), 1);
5102         assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5103         check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
5104         assert_ne!(revoked_htlc_txn[1].lock_time, 0); // HTLC-Timeout
5105
5106         // B will generate justice tx from A's revoked commitment/HTLC tx
5107         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5108         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
5109         check_closed_broadcast!(nodes[1], true);
5110         check_added_monitors!(nodes[1], 1);
5111
5112         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5113         assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
5114         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5115         // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
5116         // transactions next...
5117         assert_eq!(node_txn[0].input.len(), 3);
5118         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
5119
5120         assert_eq!(node_txn[1].input.len(), 2);
5121         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
5122         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
5123                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5124         } else {
5125                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
5126                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5127         }
5128
5129         assert_eq!(node_txn[2].input.len(), 1);
5130         check_spends!(node_txn[2], chan_1.3);
5131
5132         mine_transaction(&nodes[1], &node_txn[1]);
5133         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5134
5135         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5136         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5137         assert_eq!(spend_txn.len(), 1);
5138         assert_eq!(spend_txn[0].input.len(), 1);
5139         check_spends!(spend_txn[0], node_txn[1]);
5140 }
5141
5142 #[test]
5143 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5144         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5145         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
5146         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5147         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5148         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5149
5150         // Create some initial channels
5151         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5152
5153         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5154         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5155         assert_eq!(revoked_local_txn[0].input.len(), 1);
5156         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5157
5158         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5159         assert_eq!(revoked_local_txn[0].output.len(), 2);
5160
5161         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5162
5163         // B will generate HTLC-Success from revoked commitment tx
5164         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5165         check_closed_broadcast!(nodes[1], true);
5166         check_added_monitors!(nodes[1], 1);
5167         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5168
5169         assert_eq!(revoked_htlc_txn.len(), 2);
5170         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5171         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5172         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5173
5174         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5175         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5176         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5177
5178         // A will generate justice tx from B's revoked commitment/HTLC tx
5179         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5180         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5181         check_closed_broadcast!(nodes[0], true);
5182         check_added_monitors!(nodes[0], 1);
5183
5184         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5185         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5186
5187         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5188         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5189         // transactions next...
5190         assert_eq!(node_txn[0].input.len(), 2);
5191         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5192         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5193                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5194         } else {
5195                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5196                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5197         }
5198
5199         assert_eq!(node_txn[1].input.len(), 1);
5200         check_spends!(node_txn[1], revoked_htlc_txn[0]);
5201
5202         check_spends!(node_txn[2], chan_1.3);
5203
5204         mine_transaction(&nodes[0], &node_txn[1]);
5205         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5206
5207         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5208         // didn't try to generate any new transactions.
5209
5210         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5211         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5212         assert_eq!(spend_txn.len(), 3);
5213         assert_eq!(spend_txn[0].input.len(), 1);
5214         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5215         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5216         check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5217         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5218 }
5219
5220 #[test]
5221 fn test_onchain_to_onchain_claim() {
5222         // Test that in case of channel closure, we detect the state of output and claim HTLC
5223         // on downstream peer's remote commitment tx.
5224         // First, have C claim an HTLC against its own latest commitment transaction.
5225         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5226         // channel.
5227         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5228         // gets broadcast.
5229
5230         let chanmon_cfgs = create_chanmon_cfgs(3);
5231         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5232         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5233         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5234
5235         // Create some initial channels
5236         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5237         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5238
5239         // Ensure all nodes are at the same height
5240         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5241         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5242         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5243         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5244
5245         // Rebalance the network a bit by relaying one payment through all the channels ...
5246         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5247         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5248
5249         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5250         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5251         check_spends!(commitment_tx[0], chan_2.3);
5252         nodes[2].node.claim_funds(payment_preimage);
5253         check_added_monitors!(nodes[2], 1);
5254         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5255         assert!(updates.update_add_htlcs.is_empty());
5256         assert!(updates.update_fail_htlcs.is_empty());
5257         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5258         assert!(updates.update_fail_malformed_htlcs.is_empty());
5259
5260         mine_transaction(&nodes[2], &commitment_tx[0]);
5261         check_closed_broadcast!(nodes[2], true);
5262         check_added_monitors!(nodes[2], 1);
5263
5264         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5265         assert_eq!(c_txn.len(), 3);
5266         assert_eq!(c_txn[0], c_txn[2]);
5267         assert_eq!(commitment_tx[0], c_txn[1]);
5268         check_spends!(c_txn[1], chan_2.3);
5269         check_spends!(c_txn[2], c_txn[1]);
5270         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5271         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5272         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5273         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5274
5275         // 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
5276         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5277         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5278         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5279         {
5280                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5281                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx
5282                 assert_eq!(b_txn.len(), 2);
5283                 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
5284                 check_spends!(b_txn[1], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5285                 assert_eq!(b_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5286                 assert!(b_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5287                 assert_ne!(b_txn[1].lock_time, 0); // Timeout tx
5288                 b_txn.clear();
5289         }
5290         check_added_monitors!(nodes[1], 1);
5291         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5292         assert_eq!(msg_events.len(), 3);
5293         check_added_monitors!(nodes[1], 1);
5294         match msg_events[0] {
5295                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5296                 _ => panic!("Unexpected event"),
5297         }
5298         match msg_events[1] {
5299                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5300                 _ => panic!("Unexpected event"),
5301         }
5302         match msg_events[2] {
5303                 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, .. } } => {
5304                         assert!(update_add_htlcs.is_empty());
5305                         assert!(update_fail_htlcs.is_empty());
5306                         assert_eq!(update_fulfill_htlcs.len(), 1);
5307                         assert!(update_fail_malformed_htlcs.is_empty());
5308                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5309                 },
5310                 _ => panic!("Unexpected event"),
5311         };
5312         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5313         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5314         mine_transaction(&nodes[1], &commitment_tx[0]);
5315         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5316         // ChannelMonitor: HTLC-Success tx + HTLC-Timeout RBF Bump, ChannelManager: local commitment tx + HTLC-Success tx
5317         assert_eq!(b_txn.len(), 4);
5318         check_spends!(b_txn[2], chan_1.3);
5319         check_spends!(b_txn[3], b_txn[2]);
5320         let (htlc_success_claim, htlc_timeout_bumped) =
5321                 if b_txn[0].input[0].previous_output.txid == commitment_tx[0].txid()
5322                         { (&b_txn[0], &b_txn[1]) } else { (&b_txn[1], &b_txn[0]) };
5323         check_spends!(htlc_success_claim, commitment_tx[0]);
5324         assert_eq!(htlc_success_claim.input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5325         assert!(htlc_success_claim.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5326         assert_eq!(htlc_success_claim.lock_time, 0); // Success tx
5327         check_spends!(htlc_timeout_bumped, c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5328         assert_ne!(htlc_timeout_bumped.lock_time, 0); // Success tx
5329
5330         check_closed_broadcast!(nodes[1], true);
5331         check_added_monitors!(nodes[1], 1);
5332 }
5333
5334 #[test]
5335 fn test_duplicate_payment_hash_one_failure_one_success() {
5336         // Topology : A --> B --> C --> D
5337         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5338         // Note that because C will refuse to generate two payment secrets for the same payment hash,
5339         // we forward one of the payments onwards to D.
5340         let chanmon_cfgs = create_chanmon_cfgs(4);
5341         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5342         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
5343         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5344
5345         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5346         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5347         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5348
5349         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5350         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5351         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5352         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5353         connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
5354
5355         let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5356
5357         let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5358         // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5359         // script push size limit so that the below script length checks match
5360         // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5361         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
5362                 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV - 40, nodes[0].logger).unwrap();
5363         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5364
5365         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5366         assert_eq!(commitment_txn[0].input.len(), 1);
5367         check_spends!(commitment_txn[0], chan_2.3);
5368
5369         mine_transaction(&nodes[1], &commitment_txn[0]);
5370         check_closed_broadcast!(nodes[1], true);
5371         check_added_monitors!(nodes[1], 1);
5372         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
5373
5374         let htlc_timeout_tx;
5375         { // Extract one of the two HTLC-Timeout transaction
5376                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5377                 // ChannelMonitor: timeout tx * 3, ChannelManager: local commitment tx
5378                 assert_eq!(node_txn.len(), 4);
5379                 check_spends!(node_txn[0], chan_2.3);
5380
5381                 check_spends!(node_txn[1], commitment_txn[0]);
5382                 assert_eq!(node_txn[1].input.len(), 1);
5383                 check_spends!(node_txn[2], commitment_txn[0]);
5384                 assert_eq!(node_txn[2].input.len(), 1);
5385                 assert_eq!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
5386                 check_spends!(node_txn[3], commitment_txn[0]);
5387                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[3].input[0].previous_output);
5388
5389                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5390                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5391                 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5392                 htlc_timeout_tx = node_txn[1].clone();
5393         }
5394
5395         nodes[2].node.claim_funds(our_payment_preimage);
5396         mine_transaction(&nodes[2], &commitment_txn[0]);
5397         check_added_monitors!(nodes[2], 2);
5398         let events = nodes[2].node.get_and_clear_pending_msg_events();
5399         match events[0] {
5400                 MessageSendEvent::UpdateHTLCs { .. } => {},
5401                 _ => panic!("Unexpected event"),
5402         }
5403         match events[1] {
5404                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5405                 _ => panic!("Unexepected event"),
5406         }
5407         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5408         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)
5409         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5410         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5411         assert_eq!(htlc_success_txn[0].input.len(), 1);
5412         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5413         assert_eq!(htlc_success_txn[1].input.len(), 1);
5414         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5415         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5416         assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5417         assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5418         assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5419         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5420
5421         mine_transaction(&nodes[1], &htlc_timeout_tx);
5422         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5423         expect_pending_htlcs_forwardable!(nodes[1]);
5424         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5425         assert!(htlc_updates.update_add_htlcs.is_empty());
5426         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5427         let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5428         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5429         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5430         check_added_monitors!(nodes[1], 1);
5431
5432         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5433         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5434         {
5435                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5436                 let events = nodes[0].node.get_and_clear_pending_msg_events();
5437                 assert_eq!(events.len(), 1);
5438                 match events[0] {
5439                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
5440                         },
5441                         _ => { panic!("Unexpected event"); }
5442                 }
5443         }
5444         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5445
5446         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5447         mine_transaction(&nodes[1], &htlc_success_txn[0]);
5448         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5449         assert!(updates.update_add_htlcs.is_empty());
5450         assert!(updates.update_fail_htlcs.is_empty());
5451         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5452         assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5453         assert!(updates.update_fail_malformed_htlcs.is_empty());
5454         check_added_monitors!(nodes[1], 1);
5455
5456         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5457         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5458
5459         let events = nodes[0].node.get_and_clear_pending_events();
5460         match events[0] {
5461                 Event::PaymentSent { ref payment_preimage } => {
5462                         assert_eq!(*payment_preimage, our_payment_preimage);
5463                 }
5464                 _ => panic!("Unexpected event"),
5465         }
5466 }
5467
5468 #[test]
5469 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5470         let chanmon_cfgs = create_chanmon_cfgs(2);
5471         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5472         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5473         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5474
5475         // Create some initial channels
5476         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5477
5478         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5479         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5480         assert_eq!(local_txn.len(), 1);
5481         assert_eq!(local_txn[0].input.len(), 1);
5482         check_spends!(local_txn[0], chan_1.3);
5483
5484         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5485         nodes[1].node.claim_funds(payment_preimage);
5486         check_added_monitors!(nodes[1], 1);
5487         mine_transaction(&nodes[1], &local_txn[0]);
5488         check_added_monitors!(nodes[1], 1);
5489         let events = nodes[1].node.get_and_clear_pending_msg_events();
5490         match events[0] {
5491                 MessageSendEvent::UpdateHTLCs { .. } => {},
5492                 _ => panic!("Unexpected event"),
5493         }
5494         match events[1] {
5495                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5496                 _ => panic!("Unexepected event"),
5497         }
5498         let node_tx = {
5499                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5500                 assert_eq!(node_txn.len(), 3);
5501                 assert_eq!(node_txn[0], node_txn[2]);
5502                 assert_eq!(node_txn[1], local_txn[0]);
5503                 assert_eq!(node_txn[0].input.len(), 1);
5504                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5505                 check_spends!(node_txn[0], local_txn[0]);
5506                 node_txn[0].clone()
5507         };
5508
5509         mine_transaction(&nodes[1], &node_tx);
5510         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5511
5512         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5513         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5514         assert_eq!(spend_txn.len(), 1);
5515         check_spends!(spend_txn[0], node_tx);
5516 }
5517
5518 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5519         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5520         // unrevoked commitment transaction.
5521         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5522         // a remote RAA before they could be failed backwards (and combinations thereof).
5523         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5524         // use the same payment hashes.
5525         // Thus, we use a six-node network:
5526         //
5527         // A \         / E
5528         //    - C - D -
5529         // B /         \ F
5530         // And test where C fails back to A/B when D announces its latest commitment transaction
5531         let chanmon_cfgs = create_chanmon_cfgs(6);
5532         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5533         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5534         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5535         let logger = test_utils::TestLogger::new();
5536
5537         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5538         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5539         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5540         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5541         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5542
5543         // Rebalance and check output sanity...
5544         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5545         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5546         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5547
5548         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5549         // 0th HTLC:
5550         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
5551         // 1st HTLC:
5552         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
5553         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5554         let our_node_id = &nodes[1].node.get_our_node_id();
5555         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();
5556         // 2nd HTLC:
5557         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
5558         // 3rd HTLC:
5559         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
5560         // 4th HTLC:
5561         let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5562         // 5th HTLC:
5563         let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5564         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();
5565         // 6th HTLC:
5566         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());
5567         // 7th HTLC:
5568         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());
5569
5570         // 8th HTLC:
5571         let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5572         // 9th HTLC:
5573         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();
5574         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
5575
5576         // 10th HTLC:
5577         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
5578         // 11th HTLC:
5579         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();
5580         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());
5581
5582         // Double-check that six of the new HTLC were added
5583         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5584         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5585         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5586         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5587
5588         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5589         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5590         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5591         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5592         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5593         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5594         check_added_monitors!(nodes[4], 0);
5595         expect_pending_htlcs_forwardable!(nodes[4]);
5596         check_added_monitors!(nodes[4], 1);
5597
5598         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5599         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5600         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5601         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5602         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5603         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5604
5605         // Fail 3rd below-dust and 7th above-dust HTLCs
5606         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5607         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5608         check_added_monitors!(nodes[5], 0);
5609         expect_pending_htlcs_forwardable!(nodes[5]);
5610         check_added_monitors!(nodes[5], 1);
5611
5612         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5613         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5614         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5615         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5616
5617         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5618
5619         expect_pending_htlcs_forwardable!(nodes[3]);
5620         check_added_monitors!(nodes[3], 1);
5621         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5622         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5623         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5624         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5625         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5626         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5627         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5628         if deliver_last_raa {
5629                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5630         } else {
5631                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5632         }
5633
5634         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5635         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5636         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5637         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5638         //
5639         // We now broadcast the latest commitment transaction, which *should* result in failures for
5640         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5641         // the non-broadcast above-dust HTLCs.
5642         //
5643         // Alternatively, we may broadcast the previous commitment transaction, which should only
5644         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5645         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5646
5647         if announce_latest {
5648                 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5649         } else {
5650                 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5651         }
5652         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5653         check_closed_broadcast!(nodes[2], true);
5654         expect_pending_htlcs_forwardable!(nodes[2]);
5655         check_added_monitors!(nodes[2], 3);
5656
5657         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5658         assert_eq!(cs_msgs.len(), 2);
5659         let mut a_done = false;
5660         for msg in cs_msgs {
5661                 match msg {
5662                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5663                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5664                                 // should be failed-backwards here.
5665                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5666                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5667                                         for htlc in &updates.update_fail_htlcs {
5668                                                 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 });
5669                                         }
5670                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5671                                         assert!(!a_done);
5672                                         a_done = true;
5673                                         &nodes[0]
5674                                 } else {
5675                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5676                                         for htlc in &updates.update_fail_htlcs {
5677                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5678                                         }
5679                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5680                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5681                                         &nodes[1]
5682                                 };
5683                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5684                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5685                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5686                                 if announce_latest {
5687                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5688                                         if *node_id == nodes[0].node.get_our_node_id() {
5689                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5690                                         }
5691                                 }
5692                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5693                         },
5694                         _ => panic!("Unexpected event"),
5695                 }
5696         }
5697
5698         let as_events = nodes[0].node.get_and_clear_pending_events();
5699         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5700         let mut as_failds = HashSet::new();
5701         for event in as_events.iter() {
5702                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5703                         assert!(as_failds.insert(*payment_hash));
5704                         if *payment_hash != payment_hash_2 {
5705                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5706                         } else {
5707                                 assert!(!rejected_by_dest);
5708                         }
5709                 } else { panic!("Unexpected event"); }
5710         }
5711         assert!(as_failds.contains(&payment_hash_1));
5712         assert!(as_failds.contains(&payment_hash_2));
5713         if announce_latest {
5714                 assert!(as_failds.contains(&payment_hash_3));
5715                 assert!(as_failds.contains(&payment_hash_5));
5716         }
5717         assert!(as_failds.contains(&payment_hash_6));
5718
5719         let bs_events = nodes[1].node.get_and_clear_pending_events();
5720         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5721         let mut bs_failds = HashSet::new();
5722         for event in bs_events.iter() {
5723                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5724                         assert!(bs_failds.insert(*payment_hash));
5725                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5726                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5727                         } else {
5728                                 assert!(!rejected_by_dest);
5729                         }
5730                 } else { panic!("Unexpected event"); }
5731         }
5732         assert!(bs_failds.contains(&payment_hash_1));
5733         assert!(bs_failds.contains(&payment_hash_2));
5734         if announce_latest {
5735                 assert!(bs_failds.contains(&payment_hash_4));
5736         }
5737         assert!(bs_failds.contains(&payment_hash_5));
5738
5739         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5740         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5741         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5742         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5743         // PaymentFailureNetworkUpdates.
5744         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5745         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5746         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5747         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5748         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5749                 match event {
5750                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5751                         _ => panic!("Unexpected event"),
5752                 }
5753         }
5754 }
5755
5756 #[test]
5757 fn test_fail_backwards_latest_remote_announce_a() {
5758         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5759 }
5760
5761 #[test]
5762 fn test_fail_backwards_latest_remote_announce_b() {
5763         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5764 }
5765
5766 #[test]
5767 fn test_fail_backwards_previous_remote_announce() {
5768         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5769         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5770         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5771 }
5772
5773 #[test]
5774 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5775         let chanmon_cfgs = create_chanmon_cfgs(2);
5776         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5777         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5778         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5779
5780         // Create some initial channels
5781         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5782
5783         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5784         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5785         assert_eq!(local_txn[0].input.len(), 1);
5786         check_spends!(local_txn[0], chan_1.3);
5787
5788         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5789         mine_transaction(&nodes[0], &local_txn[0]);
5790         check_closed_broadcast!(nodes[0], true);
5791         check_added_monitors!(nodes[0], 1);
5792         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5793
5794         let htlc_timeout = {
5795                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5796                 assert_eq!(node_txn.len(), 2);
5797                 check_spends!(node_txn[0], chan_1.3);
5798                 assert_eq!(node_txn[1].input.len(), 1);
5799                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5800                 check_spends!(node_txn[1], local_txn[0]);
5801                 node_txn[1].clone()
5802         };
5803
5804         mine_transaction(&nodes[0], &htlc_timeout);
5805         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5806         expect_payment_failed!(nodes[0], our_payment_hash, true);
5807
5808         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5809         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5810         assert_eq!(spend_txn.len(), 3);
5811         check_spends!(spend_txn[0], local_txn[0]);
5812         check_spends!(spend_txn[1], htlc_timeout);
5813         check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5814 }
5815
5816 #[test]
5817 fn test_key_derivation_params() {
5818         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5819         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5820         // let us re-derive the channel key set to then derive a delayed_payment_key.
5821
5822         let chanmon_cfgs = create_chanmon_cfgs(3);
5823
5824         // We manually create the node configuration to backup the seed.
5825         let seed = [42; 32];
5826         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5827         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);
5828         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 };
5829         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5830         node_cfgs.remove(0);
5831         node_cfgs.insert(0, node);
5832
5833         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5834         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5835
5836         // Create some initial channels
5837         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5838         // for node 0
5839         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5840         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5841         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5842
5843         // Ensure all nodes are at the same height
5844         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5845         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5846         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5847         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5848
5849         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5850         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5851         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5852         assert_eq!(local_txn_1[0].input.len(), 1);
5853         check_spends!(local_txn_1[0], chan_1.3);
5854
5855         // We check funding pubkey are unique
5856         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]));
5857         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]));
5858         if from_0_funding_key_0 == from_1_funding_key_0
5859             || from_0_funding_key_0 == from_1_funding_key_1
5860             || from_0_funding_key_1 == from_1_funding_key_0
5861             || from_0_funding_key_1 == from_1_funding_key_1 {
5862                 panic!("Funding pubkeys aren't unique");
5863         }
5864
5865         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5866         mine_transaction(&nodes[0], &local_txn_1[0]);
5867         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5868         check_closed_broadcast!(nodes[0], true);
5869         check_added_monitors!(nodes[0], 1);
5870
5871         let htlc_timeout = {
5872                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5873                 assert_eq!(node_txn[1].input.len(), 1);
5874                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5875                 check_spends!(node_txn[1], local_txn_1[0]);
5876                 node_txn[1].clone()
5877         };
5878
5879         mine_transaction(&nodes[0], &htlc_timeout);
5880         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5881         expect_payment_failed!(nodes[0], our_payment_hash, true);
5882
5883         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5884         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5885         let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5886         assert_eq!(spend_txn.len(), 3);
5887         check_spends!(spend_txn[0], local_txn_1[0]);
5888         check_spends!(spend_txn[1], htlc_timeout);
5889         check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5890 }
5891
5892 #[test]
5893 fn test_static_output_closing_tx() {
5894         let chanmon_cfgs = create_chanmon_cfgs(2);
5895         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5896         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5897         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5898
5899         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5900
5901         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5902         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5903
5904         mine_transaction(&nodes[0], &closing_tx);
5905         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5906
5907         let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5908         assert_eq!(spend_txn.len(), 1);
5909         check_spends!(spend_txn[0], closing_tx);
5910
5911         mine_transaction(&nodes[1], &closing_tx);
5912         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5913
5914         let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5915         assert_eq!(spend_txn.len(), 1);
5916         check_spends!(spend_txn[0], closing_tx);
5917 }
5918
5919 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5920         let chanmon_cfgs = create_chanmon_cfgs(2);
5921         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5922         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5923         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5924         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5925
5926         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5927
5928         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5929         // present in B's local commitment transaction, but none of A's commitment transactions.
5930         assert!(nodes[1].node.claim_funds(our_payment_preimage));
5931         check_added_monitors!(nodes[1], 1);
5932
5933         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5934         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5935         let events = nodes[0].node.get_and_clear_pending_events();
5936         assert_eq!(events.len(), 1);
5937         match events[0] {
5938                 Event::PaymentSent { payment_preimage } => {
5939                         assert_eq!(payment_preimage, our_payment_preimage);
5940                 },
5941                 _ => panic!("Unexpected event"),
5942         }
5943
5944         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5945         check_added_monitors!(nodes[0], 1);
5946         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5947         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5948         check_added_monitors!(nodes[1], 1);
5949
5950         let starting_block = nodes[1].best_block_info();
5951         let mut block = Block {
5952                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5953                 txdata: vec![],
5954         };
5955         for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5956                 connect_block(&nodes[1], &block);
5957                 block.header.prev_blockhash = block.block_hash();
5958         }
5959         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5960         check_closed_broadcast!(nodes[1], true);
5961         check_added_monitors!(nodes[1], 1);
5962 }
5963
5964 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5965         let chanmon_cfgs = create_chanmon_cfgs(2);
5966         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5967         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5968         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5969         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5970         let logger = test_utils::TestLogger::new();
5971
5972         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
5973         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5974         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();
5975         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5976         check_added_monitors!(nodes[0], 1);
5977
5978         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5979
5980         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5981         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5982         // to "time out" the HTLC.
5983
5984         let starting_block = nodes[1].best_block_info();
5985         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5986
5987         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5988                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5989                 header.prev_blockhash = header.block_hash();
5990         }
5991         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5992         check_closed_broadcast!(nodes[0], true);
5993         check_added_monitors!(nodes[0], 1);
5994 }
5995
5996 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5997         let chanmon_cfgs = create_chanmon_cfgs(3);
5998         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5999         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6000         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6001         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6002
6003         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
6004         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
6005         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
6006         // actually revoked.
6007         let htlc_value = if use_dust { 50000 } else { 3000000 };
6008         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
6009         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
6010         expect_pending_htlcs_forwardable!(nodes[1]);
6011         check_added_monitors!(nodes[1], 1);
6012
6013         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6014         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
6015         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
6016         check_added_monitors!(nodes[0], 1);
6017         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6018         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
6019         check_added_monitors!(nodes[1], 1);
6020         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
6021         check_added_monitors!(nodes[1], 1);
6022         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6023
6024         if check_revoke_no_close {
6025                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
6026                 check_added_monitors!(nodes[0], 1);
6027         }
6028
6029         let starting_block = nodes[1].best_block_info();
6030         let mut block = Block {
6031                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6032                 txdata: vec![],
6033         };
6034         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
6035                 connect_block(&nodes[0], &block);
6036                 block.header.prev_blockhash = block.block_hash();
6037         }
6038         if !check_revoke_no_close {
6039                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6040                 check_closed_broadcast!(nodes[0], true);
6041                 check_added_monitors!(nodes[0], 1);
6042         } else {
6043                 expect_payment_failed!(nodes[0], our_payment_hash, true);
6044         }
6045 }
6046
6047 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
6048 // There are only a few cases to test here:
6049 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
6050 //    broadcastable commitment transactions result in channel closure,
6051 //  * its included in an unrevoked-but-previous remote commitment transaction,
6052 //  * its included in the latest remote or local commitment transactions.
6053 // We test each of the three possible commitment transactions individually and use both dust and
6054 // non-dust HTLCs.
6055 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
6056 // assume they are handled the same across all six cases, as both outbound and inbound failures are
6057 // tested for at least one of the cases in other tests.
6058 #[test]
6059 fn htlc_claim_single_commitment_only_a() {
6060         do_htlc_claim_local_commitment_only(true);
6061         do_htlc_claim_local_commitment_only(false);
6062
6063         do_htlc_claim_current_remote_commitment_only(true);
6064         do_htlc_claim_current_remote_commitment_only(false);
6065 }
6066
6067 #[test]
6068 fn htlc_claim_single_commitment_only_b() {
6069         do_htlc_claim_previous_remote_commitment_only(true, false);
6070         do_htlc_claim_previous_remote_commitment_only(false, false);
6071         do_htlc_claim_previous_remote_commitment_only(true, true);
6072         do_htlc_claim_previous_remote_commitment_only(false, true);
6073 }
6074
6075 #[test]
6076 #[should_panic]
6077 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6078         let chanmon_cfgs = create_chanmon_cfgs(2);
6079         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6080         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6081         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6082         //Force duplicate channel ids
6083         for node in nodes.iter() {
6084                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6085         }
6086
6087         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6088         let channel_value_satoshis=10000;
6089         let push_msat=10001;
6090         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6091         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6092         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6093
6094         //Create a second channel with a channel_id collision
6095         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6096 }
6097
6098 #[test]
6099 fn bolt2_open_channel_sending_node_checks_part2() {
6100         let chanmon_cfgs = create_chanmon_cfgs(2);
6101         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6102         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6103         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6104
6105         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6106         let channel_value_satoshis=2^24;
6107         let push_msat=10001;
6108         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6109
6110         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6111         let channel_value_satoshis=10000;
6112         // Test when push_msat is equal to 1000 * funding_satoshis.
6113         let push_msat=1000*channel_value_satoshis+1;
6114         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6115
6116         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6117         let channel_value_satoshis=10000;
6118         let push_msat=10001;
6119         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
6120         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6121         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6122
6123         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6124         // 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
6125         assert!(node0_to_1_send_open_channel.channel_flags<=1);
6126
6127         // 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.
6128         assert!(BREAKDOWN_TIMEOUT>0);
6129         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6130
6131         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6132         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6133         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6134
6135         // 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.
6136         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6137         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6138         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6139         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6140         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6141 }
6142
6143 #[test]
6144 fn bolt2_open_channel_sane_dust_limit() {
6145         let chanmon_cfgs = create_chanmon_cfgs(2);
6146         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6147         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6148         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6149
6150         let channel_value_satoshis=1000000;
6151         let push_msat=10001;
6152         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6153         let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6154         node0_to_1_send_open_channel.dust_limit_satoshis = 661;
6155         node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
6156
6157         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6158         let events = nodes[1].node.get_and_clear_pending_msg_events();
6159         let err_msg = match events[0] {
6160                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
6161                         msg.clone()
6162                 },
6163                 _ => panic!("Unexpected event"),
6164         };
6165         assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
6166 }
6167
6168 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6169 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6170 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6171 // is no longer affordable once it's freed.
6172 #[test]
6173 fn test_fail_holding_cell_htlc_upon_free() {
6174         let chanmon_cfgs = create_chanmon_cfgs(2);
6175         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6176         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6177         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6178         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6179         let logger = test_utils::TestLogger::new();
6180
6181         // First nodes[0] generates an update_fee, setting the channel's
6182         // pending_update_fee.
6183         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6184         check_added_monitors!(nodes[0], 1);
6185
6186         let events = nodes[0].node.get_and_clear_pending_msg_events();
6187         assert_eq!(events.len(), 1);
6188         let (update_msg, commitment_signed) = match events[0] {
6189                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6190                         (update_fee.as_ref(), commitment_signed)
6191                 },
6192                 _ => panic!("Unexpected event"),
6193         };
6194
6195         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6196
6197         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6198         let channel_reserve = chan_stat.channel_reserve_msat;
6199         let feerate = get_feerate!(nodes[0], chan.2);
6200
6201         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6202         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6203         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6204         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6205         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();
6206
6207         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6208         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6209         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6210         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6211
6212         // Flush the pending fee update.
6213         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6214         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6215         check_added_monitors!(nodes[1], 1);
6216         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6217         check_added_monitors!(nodes[0], 1);
6218
6219         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6220         // HTLC, but now that the fee has been raised the payment will now fail, causing
6221         // us to surface its failure to the user.
6222         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6223         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6224         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 1 HTLC updates".to_string(), 1);
6225         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);
6226         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6227
6228         // Check that the payment failed to be sent out.
6229         let events = nodes[0].node.get_and_clear_pending_events();
6230         assert_eq!(events.len(), 1);
6231         match &events[0] {
6232                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6233                         assert_eq!(our_payment_hash.clone(), *payment_hash);
6234                         assert_eq!(*rejected_by_dest, false);
6235                         assert_eq!(*error_code, None);
6236                         assert_eq!(*error_data, None);
6237                 },
6238                 _ => panic!("Unexpected event"),
6239         }
6240 }
6241
6242 // Test that if multiple HTLCs are released from the holding cell and one is
6243 // valid but the other is no longer valid upon release, the valid HTLC can be
6244 // successfully completed while the other one fails as expected.
6245 #[test]
6246 fn test_free_and_fail_holding_cell_htlcs() {
6247         let chanmon_cfgs = create_chanmon_cfgs(2);
6248         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6249         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6250         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6251         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6252         let logger = test_utils::TestLogger::new();
6253
6254         // First nodes[0] generates an update_fee, setting the channel's
6255         // pending_update_fee.
6256         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6257         check_added_monitors!(nodes[0], 1);
6258
6259         let events = nodes[0].node.get_and_clear_pending_msg_events();
6260         assert_eq!(events.len(), 1);
6261         let (update_msg, commitment_signed) = match events[0] {
6262                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6263                         (update_fee.as_ref(), commitment_signed)
6264                 },
6265                 _ => panic!("Unexpected event"),
6266         };
6267
6268         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6269
6270         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6271         let channel_reserve = chan_stat.channel_reserve_msat;
6272         let feerate = get_feerate!(nodes[0], chan.2);
6273
6274         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6275         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6276         let amt_1 = 20000;
6277         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6278         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6279         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6280         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();
6281         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();
6282
6283         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6284         nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6285         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6286         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6287         nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6288         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6289         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6290
6291         // Flush the pending fee update.
6292         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6293         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6294         check_added_monitors!(nodes[1], 1);
6295         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6296         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6297         check_added_monitors!(nodes[0], 2);
6298
6299         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6300         // but now that the fee has been raised the second payment will now fail, causing us
6301         // to surface its failure to the user. The first payment should succeed.
6302         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6303         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6304         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 2 HTLC updates".to_string(), 1);
6305         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);
6306         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6307
6308         // Check that the second payment failed to be sent out.
6309         let events = nodes[0].node.get_and_clear_pending_events();
6310         assert_eq!(events.len(), 1);
6311         match &events[0] {
6312                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6313                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6314                         assert_eq!(*rejected_by_dest, false);
6315                         assert_eq!(*error_code, None);
6316                         assert_eq!(*error_data, None);
6317                 },
6318                 _ => panic!("Unexpected event"),
6319         }
6320
6321         // Complete the first payment and the RAA from the fee update.
6322         let (payment_event, send_raa_event) = {
6323                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6324                 assert_eq!(msgs.len(), 2);
6325                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6326         };
6327         let raa = match send_raa_event {
6328                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6329                 _ => panic!("Unexpected event"),
6330         };
6331         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6332         check_added_monitors!(nodes[1], 1);
6333         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6334         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6335         let events = nodes[1].node.get_and_clear_pending_events();
6336         assert_eq!(events.len(), 1);
6337         match events[0] {
6338                 Event::PendingHTLCsForwardable { .. } => {},
6339                 _ => panic!("Unexpected event"),
6340         }
6341         nodes[1].node.process_pending_htlc_forwards();
6342         let events = nodes[1].node.get_and_clear_pending_events();
6343         assert_eq!(events.len(), 1);
6344         match events[0] {
6345                 Event::PaymentReceived { .. } => {},
6346                 _ => panic!("Unexpected event"),
6347         }
6348         nodes[1].node.claim_funds(payment_preimage_1);
6349         check_added_monitors!(nodes[1], 1);
6350         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6351         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6352         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6353         let events = nodes[0].node.get_and_clear_pending_events();
6354         assert_eq!(events.len(), 1);
6355         match events[0] {
6356                 Event::PaymentSent { ref payment_preimage } => {
6357                         assert_eq!(*payment_preimage, payment_preimage_1);
6358                 }
6359                 _ => panic!("Unexpected event"),
6360         }
6361 }
6362
6363 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6364 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6365 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6366 // once it's freed.
6367 #[test]
6368 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6369         let chanmon_cfgs = create_chanmon_cfgs(3);
6370         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6371         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6372         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6373         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6374         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6375         let logger = test_utils::TestLogger::new();
6376
6377         // First nodes[1] generates an update_fee, setting the channel's
6378         // pending_update_fee.
6379         nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6380         check_added_monitors!(nodes[1], 1);
6381
6382         let events = nodes[1].node.get_and_clear_pending_msg_events();
6383         assert_eq!(events.len(), 1);
6384         let (update_msg, commitment_signed) = match events[0] {
6385                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6386                         (update_fee.as_ref(), commitment_signed)
6387                 },
6388                 _ => panic!("Unexpected event"),
6389         };
6390
6391         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6392
6393         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6394         let channel_reserve = chan_stat.channel_reserve_msat;
6395         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6396
6397         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6398         let feemsat = 239;
6399         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6400         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6401         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6402         let payment_event = {
6403                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6404                 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();
6405                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6406                 check_added_monitors!(nodes[0], 1);
6407
6408                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6409                 assert_eq!(events.len(), 1);
6410
6411                 SendEvent::from_event(events.remove(0))
6412         };
6413         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6414         check_added_monitors!(nodes[1], 0);
6415         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6416         expect_pending_htlcs_forwardable!(nodes[1]);
6417
6418         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6419         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6420
6421         // Flush the pending fee update.
6422         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6423         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6424         check_added_monitors!(nodes[2], 1);
6425         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6426         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6427         check_added_monitors!(nodes[1], 2);
6428
6429         // A final RAA message is generated to finalize the fee update.
6430         let events = nodes[1].node.get_and_clear_pending_msg_events();
6431         assert_eq!(events.len(), 1);
6432
6433         let raa_msg = match &events[0] {
6434                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6435                         msg.clone()
6436                 },
6437                 _ => panic!("Unexpected event"),
6438         };
6439
6440         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6441         check_added_monitors!(nodes[2], 1);
6442         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6443
6444         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6445         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6446         assert_eq!(process_htlc_forwards_event.len(), 1);
6447         match &process_htlc_forwards_event[0] {
6448                 &Event::PendingHTLCsForwardable { .. } => {},
6449                 _ => panic!("Unexpected event"),
6450         }
6451
6452         // In response, we call ChannelManager's process_pending_htlc_forwards
6453         nodes[1].node.process_pending_htlc_forwards();
6454         check_added_monitors!(nodes[1], 1);
6455
6456         // This causes the HTLC to be failed backwards.
6457         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6458         assert_eq!(fail_event.len(), 1);
6459         let (fail_msg, commitment_signed) = match &fail_event[0] {
6460                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6461                         assert_eq!(updates.update_add_htlcs.len(), 0);
6462                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6463                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6464                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6465                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6466                 },
6467                 _ => panic!("Unexpected event"),
6468         };
6469
6470         // Pass the failure messages back to nodes[0].
6471         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6472         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6473
6474         // Complete the HTLC failure+removal process.
6475         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6476         check_added_monitors!(nodes[0], 1);
6477         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6478         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6479         check_added_monitors!(nodes[1], 2);
6480         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6481         assert_eq!(final_raa_event.len(), 1);
6482         let raa = match &final_raa_event[0] {
6483                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6484                 _ => panic!("Unexpected event"),
6485         };
6486         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6487         let fail_msg_event = nodes[0].node.get_and_clear_pending_msg_events();
6488         assert_eq!(fail_msg_event.len(), 1);
6489         match &fail_msg_event[0] {
6490                 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
6491                 _ => panic!("Unexpected event"),
6492         }
6493         let failure_event = nodes[0].node.get_and_clear_pending_events();
6494         assert_eq!(failure_event.len(), 1);
6495         match &failure_event[0] {
6496                 &Event::PaymentFailed { rejected_by_dest, .. } => {
6497                         assert!(!rejected_by_dest);
6498                 },
6499                 _ => panic!("Unexpected event"),
6500         }
6501         check_added_monitors!(nodes[0], 1);
6502 }
6503
6504 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6505 // 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.
6506 //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.
6507
6508 #[test]
6509 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6510         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6511         let chanmon_cfgs = create_chanmon_cfgs(2);
6512         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6513         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6514         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6515         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6516
6517         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6518         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6519         let logger = test_utils::TestLogger::new();
6520         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();
6521         route.paths[0][0].fee_msat = 100;
6522
6523         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6524                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6525         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6526         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6527 }
6528
6529 #[test]
6530 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6531         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6532         let chanmon_cfgs = create_chanmon_cfgs(2);
6533         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6534         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6535         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6536         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6537         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6538
6539         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6540         let logger = test_utils::TestLogger::new();
6541         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();
6542         route.paths[0][0].fee_msat = 0;
6543         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6544                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6545
6546         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6547         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6548 }
6549
6550 #[test]
6551 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6552         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6553         let chanmon_cfgs = create_chanmon_cfgs(2);
6554         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6555         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6556         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6557         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6558
6559         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6560         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6561         let logger = test_utils::TestLogger::new();
6562         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();
6563         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6564         check_added_monitors!(nodes[0], 1);
6565         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6566         updates.update_add_htlcs[0].amount_msat = 0;
6567
6568         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6569         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6570         check_closed_broadcast!(nodes[1], true).unwrap();
6571         check_added_monitors!(nodes[1], 1);
6572 }
6573
6574 #[test]
6575 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6576         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6577         //It is enforced when constructing a route.
6578         let chanmon_cfgs = create_chanmon_cfgs(2);
6579         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6580         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6581         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6582         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6583         let logger = test_utils::TestLogger::new();
6584
6585         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6586
6587         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6588         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();
6589         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6590                 assert_eq!(err, &"Channel CLTV overflowed?"));
6591 }
6592
6593 #[test]
6594 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6595         //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.
6596         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6597         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6598         let chanmon_cfgs = create_chanmon_cfgs(2);
6599         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6600         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6601         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6602         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6603         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6604
6605         let logger = test_utils::TestLogger::new();
6606         for i in 0..max_accepted_htlcs {
6607                 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6608                 let payment_event = {
6609                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6610                         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();
6611                         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6612                         check_added_monitors!(nodes[0], 1);
6613
6614                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6615                         assert_eq!(events.len(), 1);
6616                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6617                                 assert_eq!(htlcs[0].htlc_id, i);
6618                         } else {
6619                                 assert!(false);
6620                         }
6621                         SendEvent::from_event(events.remove(0))
6622                 };
6623                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6624                 check_added_monitors!(nodes[1], 0);
6625                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6626
6627                 expect_pending_htlcs_forwardable!(nodes[1]);
6628                 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6629         }
6630         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6631         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6632         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();
6633         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6634                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6635
6636         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6637         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6638 }
6639
6640 #[test]
6641 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6642         //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.
6643         let chanmon_cfgs = create_chanmon_cfgs(2);
6644         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6645         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6646         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6647         let channel_value = 100000;
6648         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6649         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6650
6651         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6652
6653         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6654         // Manually create a route over our max in flight (which our router normally automatically
6655         // limits us to.
6656         let route = Route { paths: vec![vec![RouteHop {
6657            pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6658            short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6659            fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6660         }]] };
6661         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6662                 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)));
6663
6664         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6665         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);
6666
6667         send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6668 }
6669
6670 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6671 #[test]
6672 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6673         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6674         let chanmon_cfgs = create_chanmon_cfgs(2);
6675         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6676         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6677         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6678         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6679         let htlc_minimum_msat: u64;
6680         {
6681                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6682                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6683                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6684         }
6685
6686         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6687         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6688         let logger = test_utils::TestLogger::new();
6689         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();
6690         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6691         check_added_monitors!(nodes[0], 1);
6692         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6693         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6694         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6695         assert!(nodes[1].node.list_channels().is_empty());
6696         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6697         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()));
6698         check_added_monitors!(nodes[1], 1);
6699 }
6700
6701 #[test]
6702 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6703         //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
6704         let chanmon_cfgs = create_chanmon_cfgs(2);
6705         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6706         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6707         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6708         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6709         let logger = test_utils::TestLogger::new();
6710
6711         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6712         let channel_reserve = chan_stat.channel_reserve_msat;
6713         let feerate = get_feerate!(nodes[0], chan.2);
6714         // The 2* and +1 are for the fee spike reserve.
6715         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6716
6717         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6718         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6719         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6720         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();
6721         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6722         check_added_monitors!(nodes[0], 1);
6723         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6724
6725         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6726         // at this time channel-initiatee receivers are not required to enforce that senders
6727         // respect the fee_spike_reserve.
6728         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6729         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6730
6731         assert!(nodes[1].node.list_channels().is_empty());
6732         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6733         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6734         check_added_monitors!(nodes[1], 1);
6735 }
6736
6737 #[test]
6738 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6739         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6740         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6741         let chanmon_cfgs = create_chanmon_cfgs(2);
6742         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6743         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6744         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6745         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6746         let logger = test_utils::TestLogger::new();
6747
6748         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6749         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6750
6751         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6752         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();
6753
6754         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6755         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6756         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height).unwrap();
6757         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6758
6759         let mut msg = msgs::UpdateAddHTLC {
6760                 channel_id: chan.2,
6761                 htlc_id: 0,
6762                 amount_msat: 1000,
6763                 payment_hash: our_payment_hash,
6764                 cltv_expiry: htlc_cltv,
6765                 onion_routing_packet: onion_packet.clone(),
6766         };
6767
6768         for i in 0..super::channel::OUR_MAX_HTLCS {
6769                 msg.htlc_id = i as u64;
6770                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6771         }
6772         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6773         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6774
6775         assert!(nodes[1].node.list_channels().is_empty());
6776         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6777         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6778         check_added_monitors!(nodes[1], 1);
6779 }
6780
6781 #[test]
6782 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6783         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6784         let chanmon_cfgs = create_chanmon_cfgs(2);
6785         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6786         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6787         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6788         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6789         let logger = test_utils::TestLogger::new();
6790
6791         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6792         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6793         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();
6794         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6795         check_added_monitors!(nodes[0], 1);
6796         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6797         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6798         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6799
6800         assert!(nodes[1].node.list_channels().is_empty());
6801         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6802         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6803         check_added_monitors!(nodes[1], 1);
6804 }
6805
6806 #[test]
6807 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6808         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6809         let chanmon_cfgs = create_chanmon_cfgs(2);
6810         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6811         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6812         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6813         let logger = test_utils::TestLogger::new();
6814
6815         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6816         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6817         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6818         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();
6819         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6820         check_added_monitors!(nodes[0], 1);
6821         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6822         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6823         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6824
6825         assert!(nodes[1].node.list_channels().is_empty());
6826         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6827         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6828         check_added_monitors!(nodes[1], 1);
6829 }
6830
6831 #[test]
6832 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6833         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6834         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6835         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6836         let chanmon_cfgs = create_chanmon_cfgs(2);
6837         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6838         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6839         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6840         let logger = test_utils::TestLogger::new();
6841
6842         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6843         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6844         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6845         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();
6846         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6847         check_added_monitors!(nodes[0], 1);
6848         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6849         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6850
6851         //Disconnect and Reconnect
6852         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6853         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6854         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6855         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6856         assert_eq!(reestablish_1.len(), 1);
6857         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6858         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6859         assert_eq!(reestablish_2.len(), 1);
6860         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6861         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6862         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6863         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6864
6865         //Resend HTLC
6866         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6867         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6868         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6869         check_added_monitors!(nodes[1], 1);
6870         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6871
6872         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6873
6874         assert!(nodes[1].node.list_channels().is_empty());
6875         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6876         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6877         check_added_monitors!(nodes[1], 1);
6878 }
6879
6880 #[test]
6881 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6882         //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.
6883
6884         let chanmon_cfgs = create_chanmon_cfgs(2);
6885         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6886         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6887         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6888         let logger = test_utils::TestLogger::new();
6889         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6890         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6891         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6892         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();
6893         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6894
6895         check_added_monitors!(nodes[0], 1);
6896         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6897         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6898
6899         let update_msg = msgs::UpdateFulfillHTLC{
6900                 channel_id: chan.2,
6901                 htlc_id: 0,
6902                 payment_preimage: our_payment_preimage,
6903         };
6904
6905         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6906
6907         assert!(nodes[0].node.list_channels().is_empty());
6908         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6909         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()));
6910         check_added_monitors!(nodes[0], 1);
6911 }
6912
6913 #[test]
6914 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6915         //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.
6916
6917         let chanmon_cfgs = create_chanmon_cfgs(2);
6918         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6919         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6920         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6921         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6922         let logger = test_utils::TestLogger::new();
6923
6924         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6925         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6926         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();
6927         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6928         check_added_monitors!(nodes[0], 1);
6929         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6930         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6931
6932         let update_msg = msgs::UpdateFailHTLC{
6933                 channel_id: chan.2,
6934                 htlc_id: 0,
6935                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6936         };
6937
6938         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6939
6940         assert!(nodes[0].node.list_channels().is_empty());
6941         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6942         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()));
6943         check_added_monitors!(nodes[0], 1);
6944 }
6945
6946 #[test]
6947 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6948         //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.
6949
6950         let chanmon_cfgs = create_chanmon_cfgs(2);
6951         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6952         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6953         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6954         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6955         let logger = test_utils::TestLogger::new();
6956
6957         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6958         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6959         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();
6960         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6961         check_added_monitors!(nodes[0], 1);
6962         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6963         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6964         let update_msg = msgs::UpdateFailMalformedHTLC{
6965                 channel_id: chan.2,
6966                 htlc_id: 0,
6967                 sha256_of_onion: [1; 32],
6968                 failure_code: 0x8000,
6969         };
6970
6971         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6972
6973         assert!(nodes[0].node.list_channels().is_empty());
6974         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6975         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()));
6976         check_added_monitors!(nodes[0], 1);
6977 }
6978
6979 #[test]
6980 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6981         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6982
6983         let chanmon_cfgs = create_chanmon_cfgs(2);
6984         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6985         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6986         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6987         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6988
6989         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6990
6991         nodes[1].node.claim_funds(our_payment_preimage);
6992         check_added_monitors!(nodes[1], 1);
6993
6994         let events = nodes[1].node.get_and_clear_pending_msg_events();
6995         assert_eq!(events.len(), 1);
6996         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6997                 match events[0] {
6998                         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, .. } } => {
6999                                 assert!(update_add_htlcs.is_empty());
7000                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7001                                 assert!(update_fail_htlcs.is_empty());
7002                                 assert!(update_fail_malformed_htlcs.is_empty());
7003                                 assert!(update_fee.is_none());
7004                                 update_fulfill_htlcs[0].clone()
7005                         },
7006                         _ => panic!("Unexpected event"),
7007                 }
7008         };
7009
7010         update_fulfill_msg.htlc_id = 1;
7011
7012         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7013
7014         assert!(nodes[0].node.list_channels().is_empty());
7015         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7016         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
7017         check_added_monitors!(nodes[0], 1);
7018 }
7019
7020 #[test]
7021 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
7022         //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.
7023
7024         let chanmon_cfgs = create_chanmon_cfgs(2);
7025         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7026         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7027         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7028         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7029
7030         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7031
7032         nodes[1].node.claim_funds(our_payment_preimage);
7033         check_added_monitors!(nodes[1], 1);
7034
7035         let events = nodes[1].node.get_and_clear_pending_msg_events();
7036         assert_eq!(events.len(), 1);
7037         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7038                 match events[0] {
7039                         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, .. } } => {
7040                                 assert!(update_add_htlcs.is_empty());
7041                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7042                                 assert!(update_fail_htlcs.is_empty());
7043                                 assert!(update_fail_malformed_htlcs.is_empty());
7044                                 assert!(update_fee.is_none());
7045                                 update_fulfill_htlcs[0].clone()
7046                         },
7047                         _ => panic!("Unexpected event"),
7048                 }
7049         };
7050
7051         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
7052
7053         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7054
7055         assert!(nodes[0].node.list_channels().is_empty());
7056         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7057         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
7058         check_added_monitors!(nodes[0], 1);
7059 }
7060
7061 #[test]
7062 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
7063         //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.
7064
7065         let chanmon_cfgs = create_chanmon_cfgs(2);
7066         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7067         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7068         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7069         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7070         let logger = test_utils::TestLogger::new();
7071
7072         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7073         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7074         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();
7075         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7076         check_added_monitors!(nodes[0], 1);
7077
7078         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7079         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7080
7081         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7082         check_added_monitors!(nodes[1], 0);
7083         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7084
7085         let events = nodes[1].node.get_and_clear_pending_msg_events();
7086
7087         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7088                 match events[0] {
7089                         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, .. } } => {
7090                                 assert!(update_add_htlcs.is_empty());
7091                                 assert!(update_fulfill_htlcs.is_empty());
7092                                 assert!(update_fail_htlcs.is_empty());
7093                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7094                                 assert!(update_fee.is_none());
7095                                 update_fail_malformed_htlcs[0].clone()
7096                         },
7097                         _ => panic!("Unexpected event"),
7098                 }
7099         };
7100         update_msg.failure_code &= !0x8000;
7101         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7102
7103         assert!(nodes[0].node.list_channels().is_empty());
7104         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7105         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7106         check_added_monitors!(nodes[0], 1);
7107 }
7108
7109 #[test]
7110 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7111         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7112         //    * 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.
7113
7114         let chanmon_cfgs = create_chanmon_cfgs(3);
7115         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7116         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7117         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7118         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7119         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7120         let logger = test_utils::TestLogger::new();
7121
7122         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7123
7124         //First hop
7125         let mut payment_event = {
7126                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7127                 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();
7128                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7129                 check_added_monitors!(nodes[0], 1);
7130                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7131                 assert_eq!(events.len(), 1);
7132                 SendEvent::from_event(events.remove(0))
7133         };
7134         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7135         check_added_monitors!(nodes[1], 0);
7136         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7137         expect_pending_htlcs_forwardable!(nodes[1]);
7138         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7139         assert_eq!(events_2.len(), 1);
7140         check_added_monitors!(nodes[1], 1);
7141         payment_event = SendEvent::from_event(events_2.remove(0));
7142         assert_eq!(payment_event.msgs.len(), 1);
7143
7144         //Second Hop
7145         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7146         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7147         check_added_monitors!(nodes[2], 0);
7148         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7149
7150         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7151         assert_eq!(events_3.len(), 1);
7152         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7153                 match events_3[0] {
7154                         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 } } => {
7155                                 assert!(update_add_htlcs.is_empty());
7156                                 assert!(update_fulfill_htlcs.is_empty());
7157                                 assert!(update_fail_htlcs.is_empty());
7158                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7159                                 assert!(update_fee.is_none());
7160                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7161                         },
7162                         _ => panic!("Unexpected event"),
7163                 }
7164         };
7165
7166         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7167
7168         check_added_monitors!(nodes[1], 0);
7169         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7170         expect_pending_htlcs_forwardable!(nodes[1]);
7171         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7172         assert_eq!(events_4.len(), 1);
7173
7174         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7175         match events_4[0] {
7176                 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, .. } } => {
7177                         assert!(update_add_htlcs.is_empty());
7178                         assert!(update_fulfill_htlcs.is_empty());
7179                         assert_eq!(update_fail_htlcs.len(), 1);
7180                         assert!(update_fail_malformed_htlcs.is_empty());
7181                         assert!(update_fee.is_none());
7182                 },
7183                 _ => panic!("Unexpected event"),
7184         };
7185
7186         check_added_monitors!(nodes[1], 1);
7187 }
7188
7189 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7190         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7191         // 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
7192         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7193
7194         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7195         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7196         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7197         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7198         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7199         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7200
7201         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7202
7203         // We route 2 dust-HTLCs between A and B
7204         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7205         let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7206         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7207
7208         // Cache one local commitment tx as previous
7209         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7210
7211         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7212         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7213         check_added_monitors!(nodes[1], 0);
7214         expect_pending_htlcs_forwardable!(nodes[1]);
7215         check_added_monitors!(nodes[1], 1);
7216
7217         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7218         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7219         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7220         check_added_monitors!(nodes[0], 1);
7221
7222         // Cache one local commitment tx as lastest
7223         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7224
7225         let events = nodes[0].node.get_and_clear_pending_msg_events();
7226         match events[0] {
7227                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7228                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7229                 },
7230                 _ => panic!("Unexpected event"),
7231         }
7232         match events[1] {
7233                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7234                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7235                 },
7236                 _ => panic!("Unexpected event"),
7237         }
7238
7239         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7240         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7241         if announce_latest {
7242                 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7243         } else {
7244                 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7245         }
7246
7247         check_closed_broadcast!(nodes[0], true);
7248         check_added_monitors!(nodes[0], 1);
7249
7250         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7251         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7252         let events = nodes[0].node.get_and_clear_pending_events();
7253         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7254         assert_eq!(events.len(), 2);
7255         let mut first_failed = false;
7256         for event in events {
7257                 match event {
7258                         Event::PaymentFailed { payment_hash, .. } => {
7259                                 if payment_hash == payment_hash_1 {
7260                                         assert!(!first_failed);
7261                                         first_failed = true;
7262                                 } else {
7263                                         assert_eq!(payment_hash, payment_hash_2);
7264                                 }
7265                         }
7266                         _ => panic!("Unexpected event"),
7267                 }
7268         }
7269 }
7270
7271 #[test]
7272 fn test_failure_delay_dust_htlc_local_commitment() {
7273         do_test_failure_delay_dust_htlc_local_commitment(true);
7274         do_test_failure_delay_dust_htlc_local_commitment(false);
7275 }
7276
7277 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7278         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7279         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7280         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7281         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7282         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7283         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7284
7285         let chanmon_cfgs = create_chanmon_cfgs(3);
7286         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7287         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7288         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7289         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7290
7291         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7292
7293         let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7294         let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7295
7296         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7297         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7298
7299         // We revoked bs_commitment_tx
7300         if revoked {
7301                 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7302                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7303         }
7304
7305         let mut timeout_tx = Vec::new();
7306         if local {
7307                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7308                 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7309                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7310                 expect_payment_failed!(nodes[0], dust_hash, true);
7311
7312                 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
7313                 check_closed_broadcast!(nodes[0], true);
7314                 check_added_monitors!(nodes[0], 1);
7315                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7316                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7317                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7318                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7319                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7320                 mine_transaction(&nodes[0], &timeout_tx[0]);
7321                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7322                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7323         } else {
7324                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7325                 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7326                 check_closed_broadcast!(nodes[0], true);
7327                 check_added_monitors!(nodes[0], 1);
7328                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7329                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7330                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7331                 if !revoked {
7332                         expect_payment_failed!(nodes[0], dust_hash, true);
7333                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7334                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7335                         mine_transaction(&nodes[0], &timeout_tx[0]);
7336                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7337                         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7338                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7339                 } else {
7340                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7341                         // commitment tx
7342                         let events = nodes[0].node.get_and_clear_pending_events();
7343                         assert_eq!(events.len(), 2);
7344                         let first;
7345                         match events[0] {
7346                                 Event::PaymentFailed { payment_hash, .. } => {
7347                                         if payment_hash == dust_hash { first = true; }
7348                                         else { first = false; }
7349                                 },
7350                                 _ => panic!("Unexpected event"),
7351                         }
7352                         match events[1] {
7353                                 Event::PaymentFailed { payment_hash, .. } => {
7354                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7355                                         else { assert_eq!(payment_hash, dust_hash); }
7356                                 },
7357                                 _ => panic!("Unexpected event"),
7358                         }
7359                 }
7360         }
7361 }
7362
7363 #[test]
7364 fn test_sweep_outbound_htlc_failure_update() {
7365         do_test_sweep_outbound_htlc_failure_update(false, true);
7366         do_test_sweep_outbound_htlc_failure_update(false, false);
7367         do_test_sweep_outbound_htlc_failure_update(true, false);
7368 }
7369
7370 #[test]
7371 fn test_upfront_shutdown_script() {
7372         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7373         // enforce it at shutdown message
7374
7375         let mut config = UserConfig::default();
7376         config.channel_options.announced_channel = true;
7377         config.peer_channel_config_limits.force_announced_channel_preference = false;
7378         config.channel_options.commit_upfront_shutdown_pubkey = false;
7379         let user_cfgs = [None, Some(config), None];
7380         let chanmon_cfgs = create_chanmon_cfgs(3);
7381         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7382         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7383         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7384
7385         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7386         let flags = InitFeatures::known();
7387         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7388         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7389         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7390         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7391         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7392         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7393     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()));
7394         check_added_monitors!(nodes[2], 1);
7395
7396         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7397         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7398         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7399         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7400         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7401         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7402         let events = nodes[2].node.get_and_clear_pending_msg_events();
7403         assert_eq!(events.len(), 1);
7404         match events[0] {
7405                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7406                 _ => panic!("Unexpected event"),
7407         }
7408
7409         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7410         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7411         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7412         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7413         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7414         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7415         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7416         let events = nodes[1].node.get_and_clear_pending_msg_events();
7417         assert_eq!(events.len(), 1);
7418         match events[0] {
7419                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7420                 _ => panic!("Unexpected event"),
7421         }
7422
7423         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7424         // channel smoothly, opt-out is from channel initiator here
7425         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7426         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7427         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7428         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7429         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7430         let events = nodes[0].node.get_and_clear_pending_msg_events();
7431         assert_eq!(events.len(), 1);
7432         match events[0] {
7433                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7434                 _ => panic!("Unexpected event"),
7435         }
7436
7437         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7438         //// channel smoothly
7439         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7440         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7441         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7442         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7443         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7444         let events = nodes[0].node.get_and_clear_pending_msg_events();
7445         assert_eq!(events.len(), 2);
7446         match events[0] {
7447                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7448                 _ => panic!("Unexpected event"),
7449         }
7450         match events[1] {
7451                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7452                 _ => panic!("Unexpected event"),
7453         }
7454 }
7455
7456 #[test]
7457 fn test_upfront_shutdown_script_unsupport_segwit() {
7458         // We test that channel is closed early
7459         // if a segwit program is passed as upfront shutdown script,
7460         // but the peer does not support segwit.
7461         let chanmon_cfgs = create_chanmon_cfgs(2);
7462         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7463         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7464         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7465
7466         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7467
7468         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7469         open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(16)
7470                 .push_slice(&[0, 0])
7471                 .into_script());
7472
7473         let features = InitFeatures::known().clear_shutdown_anysegwit();
7474         nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), features, &open_channel);
7475
7476         let events = nodes[0].node.get_and_clear_pending_msg_events();
7477         assert_eq!(events.len(), 1);
7478         match events[0] {
7479                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7480                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
7481                         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));
7482                 },
7483                 _ => panic!("Unexpected event"),
7484         }
7485 }
7486
7487 #[test]
7488 fn test_shutdown_script_any_segwit_allowed() {
7489         let mut config = UserConfig::default();
7490         config.channel_options.announced_channel = true;
7491         config.peer_channel_config_limits.force_announced_channel_preference = false;
7492         config.channel_options.commit_upfront_shutdown_pubkey = false;
7493         let user_cfgs = [None, Some(config), None];
7494         let chanmon_cfgs = create_chanmon_cfgs(3);
7495         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7496         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7497         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7498
7499         //// We test if the remote peer accepts opt_shutdown_anysegwit, a witness program can be used on shutdown
7500         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7501         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7502         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7503         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7504                 .push_slice(&[0, 0])
7505                 .into_script();
7506         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7507         let events = nodes[0].node.get_and_clear_pending_msg_events();
7508         assert_eq!(events.len(), 2);
7509         match events[0] {
7510                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7511                 _ => panic!("Unexpected event"),
7512         }
7513         match events[1] {
7514                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7515                 _ => panic!("Unexpected event"),
7516         }
7517 }
7518
7519 #[test]
7520 fn test_shutdown_script_any_segwit_not_allowed() {
7521         let mut config = UserConfig::default();
7522         config.channel_options.announced_channel = true;
7523         config.peer_channel_config_limits.force_announced_channel_preference = false;
7524         config.channel_options.commit_upfront_shutdown_pubkey = false;
7525         let user_cfgs = [None, Some(config), None];
7526         let chanmon_cfgs = create_chanmon_cfgs(3);
7527         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7528         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7529         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7530
7531         //// We test that if the remote peer does not accept opt_shutdown_anysegwit, the witness program cannot be used on shutdown
7532         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7533         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7534         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7535         // Make an any segwit version script
7536         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7537                 .push_slice(&[0, 0])
7538                 .into_script();
7539         let flags_no = InitFeatures::known().clear_shutdown_anysegwit();
7540         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &flags_no, &node_0_shutdown);
7541         let events = nodes[0].node.get_and_clear_pending_msg_events();
7542         assert_eq!(events.len(), 2);
7543         match events[1] {
7544                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7545                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7546                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020000) from remote peer".to_owned())
7547                 },
7548                 _ => panic!("Unexpected event"),
7549         }
7550         check_added_monitors!(nodes[0], 1);
7551 }
7552
7553 #[test]
7554 fn test_shutdown_script_segwit_but_not_anysegwit() {
7555         let mut config = UserConfig::default();
7556         config.channel_options.announced_channel = true;
7557         config.peer_channel_config_limits.force_announced_channel_preference = false;
7558         config.channel_options.commit_upfront_shutdown_pubkey = false;
7559         let user_cfgs = [None, Some(config), None];
7560         let chanmon_cfgs = create_chanmon_cfgs(3);
7561         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7562         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7563         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7564
7565         //// We test that if shutdown any segwit is supported and we send a witness script with 0 version, this is not accepted
7566         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7567         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7568         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7569         // Make a segwit script that is not a valid as any segwit
7570         node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7571                 .push_slice(&[0, 0])
7572                 .into_script();
7573         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7574         let events = nodes[0].node.get_and_clear_pending_msg_events();
7575         assert_eq!(events.len(), 2);
7576         match events[1] {
7577                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7578                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7579                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7580                 },
7581                 _ => panic!("Unexpected event"),
7582         }
7583         check_added_monitors!(nodes[0], 1);
7584 }
7585
7586 #[test]
7587 fn test_user_configurable_csv_delay() {
7588         // We test our channel constructors yield errors when we pass them absurd csv delay
7589
7590         let mut low_our_to_self_config = UserConfig::default();
7591         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7592         let mut high_their_to_self_config = UserConfig::default();
7593         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7594         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7595         let chanmon_cfgs = create_chanmon_cfgs(2);
7596         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7597         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7598         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7599
7600         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7601         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) {
7602                 match error {
7603                         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())); },
7604                         _ => panic!("Unexpected event"),
7605                 }
7606         } else { assert!(false) }
7607
7608         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7609         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7610         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7611         open_channel.to_self_delay = 200;
7612         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) {
7613                 match error {
7614                         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()));  },
7615                         _ => panic!("Unexpected event"),
7616                 }
7617         } else { assert!(false); }
7618
7619         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7620         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7621         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()));
7622         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7623         accept_channel.to_self_delay = 200;
7624         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7625         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7626                 match action {
7627                         &ErrorAction::SendErrorMessage { ref msg } => {
7628                                 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()));
7629                         },
7630                         _ => { assert!(false); }
7631                 }
7632         } else { assert!(false); }
7633
7634         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7635         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7636         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7637         open_channel.to_self_delay = 200;
7638         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) {
7639                 match error {
7640                         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())); },
7641                         _ => panic!("Unexpected event"),
7642                 }
7643         } else { assert!(false); }
7644 }
7645
7646 #[test]
7647 fn test_data_loss_protect() {
7648         // We want to be sure that :
7649         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7650         //   (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7651         // * we close channel in case of detecting other being fallen behind
7652         // * we are able to claim our own outputs thanks to to_remote being static
7653         // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7654         let persister;
7655         let logger;
7656         let fee_estimator;
7657         let tx_broadcaster;
7658         let chain_source;
7659         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7660         // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7661         // during signing due to revoked tx
7662         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7663         let keys_manager = &chanmon_cfgs[0].keys_manager;
7664         let monitor;
7665         let node_state_0;
7666         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7667         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7668         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7669
7670         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7671
7672         // Cache node A state before any channel update
7673         let previous_node_state = nodes[0].node.encode();
7674         let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7675         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7676
7677         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7678         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7679
7680         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7681         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7682
7683         // Restore node A from previous state
7684         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7685         let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7686         chain_source = test_utils::TestChainSource::new(Network::Testnet);
7687         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7688         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7689         persister = test_utils::TestPersister::new();
7690         monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7691         node_state_0 = {
7692                 let mut channel_monitors = HashMap::new();
7693                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7694                 <(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 {
7695                         keys_manager: keys_manager,
7696                         fee_estimator: &fee_estimator,
7697                         chain_monitor: &monitor,
7698                         logger: &logger,
7699                         tx_broadcaster: &tx_broadcaster,
7700                         default_config: UserConfig::default(),
7701                         channel_monitors,
7702                 }).unwrap().1
7703         };
7704         nodes[0].node = &node_state_0;
7705         assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7706         nodes[0].chain_monitor = &monitor;
7707         nodes[0].chain_source = &chain_source;
7708
7709         check_added_monitors!(nodes[0], 1);
7710
7711         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7712         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7713
7714         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7715
7716         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7717         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7718         check_added_monitors!(nodes[0], 1);
7719
7720         {
7721                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7722                 assert_eq!(node_txn.len(), 0);
7723         }
7724
7725         let mut reestablish_1 = Vec::with_capacity(1);
7726         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7727                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7728                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7729                         reestablish_1.push(msg.clone());
7730                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7731                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7732                         match action {
7733                                 &ErrorAction::SendErrorMessage { ref msg } => {
7734                                         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");
7735                                 },
7736                                 _ => panic!("Unexpected event!"),
7737                         }
7738                 } else {
7739                         panic!("Unexpected event")
7740                 }
7741         }
7742
7743         // Check we close channel detecting A is fallen-behind
7744         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7745         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7746         check_added_monitors!(nodes[1], 1);
7747
7748
7749         // Check A is able to claim to_remote output
7750         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7751         assert_eq!(node_txn.len(), 1);
7752         check_spends!(node_txn[0], chan.3);
7753         assert_eq!(node_txn[0].output.len(), 2);
7754         mine_transaction(&nodes[0], &node_txn[0]);
7755         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7756         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 1000000);
7757         assert_eq!(spend_txn.len(), 1);
7758         check_spends!(spend_txn[0], node_txn[0]);
7759 }
7760
7761 #[test]
7762 fn test_check_htlc_underpaying() {
7763         // Send payment through A -> B but A is maliciously
7764         // sending a probe payment (i.e less than expected value0
7765         // to B, B should refuse payment.
7766
7767         let chanmon_cfgs = create_chanmon_cfgs(2);
7768         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7769         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7770         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7771
7772         // Create some initial channels
7773         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7774
7775         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();
7776         let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7777         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7778         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7779         check_added_monitors!(nodes[0], 1);
7780
7781         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7782         assert_eq!(events.len(), 1);
7783         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7784         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7785         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7786
7787         // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7788         // and then will wait a second random delay before failing the HTLC back:
7789         expect_pending_htlcs_forwardable!(nodes[1]);
7790         expect_pending_htlcs_forwardable!(nodes[1]);
7791
7792         // Node 3 is expecting payment of 100_000 but received 10_000,
7793         // it should fail htlc like we didn't know the preimage.
7794         nodes[1].node.process_pending_htlc_forwards();
7795
7796         let events = nodes[1].node.get_and_clear_pending_msg_events();
7797         assert_eq!(events.len(), 1);
7798         let (update_fail_htlc, commitment_signed) = match events[0] {
7799                 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 } } => {
7800                         assert!(update_add_htlcs.is_empty());
7801                         assert!(update_fulfill_htlcs.is_empty());
7802                         assert_eq!(update_fail_htlcs.len(), 1);
7803                         assert!(update_fail_malformed_htlcs.is_empty());
7804                         assert!(update_fee.is_none());
7805                         (update_fail_htlcs[0].clone(), commitment_signed)
7806                 },
7807                 _ => panic!("Unexpected event"),
7808         };
7809         check_added_monitors!(nodes[1], 1);
7810
7811         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7812         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7813
7814         // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7815         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7816         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7817         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7818 }
7819
7820 #[test]
7821 fn test_announce_disable_channels() {
7822         // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7823         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7824
7825         let chanmon_cfgs = create_chanmon_cfgs(2);
7826         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7827         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7828         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7829
7830         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7831         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7832         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7833
7834         // Disconnect peers
7835         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7836         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7837
7838         nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7839         nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7840         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7841         assert_eq!(msg_events.len(), 3);
7842         let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7843         for e in msg_events {
7844                 match e {
7845                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7846                                 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7847                                 // Check that each channel gets updated exactly once
7848                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7849                                         panic!("Generated ChannelUpdate for wrong chan!");
7850                                 }
7851                         },
7852                         _ => panic!("Unexpected event"),
7853                 }
7854         }
7855         // Reconnect peers
7856         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7857         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7858         assert_eq!(reestablish_1.len(), 3);
7859         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7860         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7861         assert_eq!(reestablish_2.len(), 3);
7862
7863         // Reestablish chan_1
7864         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7865         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7866         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7867         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7868         // Reestablish chan_2
7869         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7870         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7871         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7872         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7873         // Reestablish chan_3
7874         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7875         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7876         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7877         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7878
7879         nodes[0].node.timer_tick_occurred();
7880         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7881         nodes[0].node.timer_tick_occurred();
7882         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7883         assert_eq!(msg_events.len(), 3);
7884         chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7885         for e in msg_events {
7886                 match e {
7887                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7888                                 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7889                                 // Check that each channel gets updated exactly once
7890                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7891                                         panic!("Generated ChannelUpdate for wrong chan!");
7892                                 }
7893                         },
7894                         _ => panic!("Unexpected event"),
7895                 }
7896         }
7897 }
7898
7899 #[test]
7900 fn test_bump_penalty_txn_on_revoked_commitment() {
7901         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7902         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7903
7904         let chanmon_cfgs = create_chanmon_cfgs(2);
7905         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7906         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7907         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7908
7909         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7910         let logger = test_utils::TestLogger::new();
7911
7912         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7913         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7914         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();
7915         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7916
7917         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7918         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7919         assert_eq!(revoked_txn[0].output.len(), 4);
7920         assert_eq!(revoked_txn[0].input.len(), 1);
7921         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7922         let revoked_txid = revoked_txn[0].txid();
7923
7924         let mut penalty_sum = 0;
7925         for outp in revoked_txn[0].output.iter() {
7926                 if outp.script_pubkey.is_v0_p2wsh() {
7927                         penalty_sum += outp.value;
7928                 }
7929         }
7930
7931         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7932         let header_114 = connect_blocks(&nodes[1], 14);
7933
7934         // Actually revoke tx by claiming a HTLC
7935         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7936         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7937         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7938         check_added_monitors!(nodes[1], 1);
7939
7940         // One or more justice tx should have been broadcast, check it
7941         let penalty_1;
7942         let feerate_1;
7943         {
7944                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7945                 assert_eq!(node_txn.len(), 2); // justice tx (broadcasted from ChannelMonitor) + local commitment tx
7946                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7947                 assert_eq!(node_txn[0].output.len(), 1);
7948                 check_spends!(node_txn[0], revoked_txn[0]);
7949                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7950                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7951                 penalty_1 = node_txn[0].txid();
7952                 node_txn.clear();
7953         };
7954
7955         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7956         connect_blocks(&nodes[1], 15);
7957         let mut penalty_2 = penalty_1;
7958         let mut feerate_2 = 0;
7959         {
7960                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7961                 assert_eq!(node_txn.len(), 1);
7962                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7963                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7964                         assert_eq!(node_txn[0].output.len(), 1);
7965                         check_spends!(node_txn[0], revoked_txn[0]);
7966                         penalty_2 = node_txn[0].txid();
7967                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7968                         assert_ne!(penalty_2, penalty_1);
7969                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7970                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7971                         // Verify 25% bump heuristic
7972                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7973                         node_txn.clear();
7974                 }
7975         }
7976         assert_ne!(feerate_2, 0);
7977
7978         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7979         connect_blocks(&nodes[1], 1);
7980         let penalty_3;
7981         let mut feerate_3 = 0;
7982         {
7983                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7984                 assert_eq!(node_txn.len(), 1);
7985                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7986                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7987                         assert_eq!(node_txn[0].output.len(), 1);
7988                         check_spends!(node_txn[0], revoked_txn[0]);
7989                         penalty_3 = node_txn[0].txid();
7990                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7991                         assert_ne!(penalty_3, penalty_2);
7992                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7993                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7994                         // Verify 25% bump heuristic
7995                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7996                         node_txn.clear();
7997                 }
7998         }
7999         assert_ne!(feerate_3, 0);
8000
8001         nodes[1].node.get_and_clear_pending_events();
8002         nodes[1].node.get_and_clear_pending_msg_events();
8003 }
8004
8005 #[test]
8006 fn test_bump_penalty_txn_on_revoked_htlcs() {
8007         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
8008         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
8009
8010         let mut chanmon_cfgs = create_chanmon_cfgs(2);
8011         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
8012         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8013         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8014         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8015
8016         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8017         // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
8018         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
8019                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8020         let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
8021         let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph.read().unwrap(),
8022                 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8023         send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
8024
8025         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8026         assert_eq!(revoked_local_txn[0].input.len(), 1);
8027         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8028
8029         // Revoke local commitment tx
8030         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8031
8032         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8033         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
8034         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
8035         check_closed_broadcast!(nodes[1], true);
8036         check_added_monitors!(nodes[1], 1);
8037         connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
8038
8039         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8040         assert_eq!(revoked_htlc_txn.len(), 3);
8041         check_spends!(revoked_htlc_txn[1], chan.3);
8042
8043         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
8044         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8045         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8046
8047         assert_eq!(revoked_htlc_txn[2].input.len(), 1);
8048         assert_eq!(revoked_htlc_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8049         assert_eq!(revoked_htlc_txn[2].output.len(), 1);
8050         check_spends!(revoked_htlc_txn[2], revoked_local_txn[0]);
8051
8052         // Broadcast set of revoked txn on A
8053         let hash_128 = connect_blocks(&nodes[0], 40);
8054         let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8055         connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
8056         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8057         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[2].clone()] });
8058         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8059         let first;
8060         let feerate_1;
8061         let penalty_txn;
8062         {
8063                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8064                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
8065                 // Verify claim tx are spending revoked HTLC txn
8066
8067                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
8068                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
8069                 // which are included in the same block (they are broadcasted because we scan the
8070                 // transactions linearly and generate claims as we go, they likely should be removed in the
8071                 // future).
8072                 assert_eq!(node_txn[0].input.len(), 1);
8073                 check_spends!(node_txn[0], revoked_local_txn[0]);
8074                 assert_eq!(node_txn[1].input.len(), 1);
8075                 check_spends!(node_txn[1], revoked_local_txn[0]);
8076                 assert_eq!(node_txn[2].input.len(), 1);
8077                 check_spends!(node_txn[2], revoked_local_txn[0]);
8078
8079                 // Each of the three justice transactions claim a separate (single) output of the three
8080                 // available, which we check here:
8081                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
8082                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
8083                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
8084
8085                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8086                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8087
8088                 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
8089                 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
8090                 // a remote commitment tx has already been confirmed).
8091                 check_spends!(node_txn[3], chan.3);
8092
8093                 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
8094                 // output, checked above).
8095                 assert_eq!(node_txn[4].input.len(), 2);
8096                 assert_eq!(node_txn[4].output.len(), 1);
8097                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8098
8099                 first = node_txn[4].txid();
8100                 // Store both feerates for later comparison
8101                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[4].output[0].value;
8102                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
8103                 penalty_txn = vec![node_txn[2].clone()];
8104                 node_txn.clear();
8105         }
8106
8107         // Connect one more block to see if bumped penalty are issued for HTLC txn
8108         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8109         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8110         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8111         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
8112         {
8113                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8114                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
8115
8116                 check_spends!(node_txn[0], revoked_local_txn[0]);
8117                 check_spends!(node_txn[1], revoked_local_txn[0]);
8118                 // Note that these are both bogus - they spend outputs already claimed in block 129:
8119                 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output  {
8120                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8121                 } else {
8122                         assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8123                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8124                 }
8125
8126                 node_txn.clear();
8127         };
8128
8129         // Few more blocks to confirm penalty txn
8130         connect_blocks(&nodes[0], 4);
8131         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8132         let header_144 = connect_blocks(&nodes[0], 9);
8133         let node_txn = {
8134                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8135                 assert_eq!(node_txn.len(), 1);
8136
8137                 assert_eq!(node_txn[0].input.len(), 2);
8138                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8139                 // Verify bumped tx is different and 25% bump heuristic
8140                 assert_ne!(first, node_txn[0].txid());
8141                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[0].output[0].value;
8142                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8143                 assert!(feerate_2 * 100 > feerate_1 * 125);
8144                 let txn = vec![node_txn[0].clone()];
8145                 node_txn.clear();
8146                 txn
8147         };
8148         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8149         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8150         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
8151         connect_blocks(&nodes[0], 20);
8152         {
8153                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8154                 // We verify than no new transaction has been broadcast because previously
8155                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8156                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8157                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8158                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8159                 // up bumped justice generation.
8160                 assert_eq!(node_txn.len(), 0);
8161                 node_txn.clear();
8162         }
8163         check_closed_broadcast!(nodes[0], true);
8164         check_added_monitors!(nodes[0], 1);
8165 }
8166
8167 #[test]
8168 fn test_bump_penalty_txn_on_remote_commitment() {
8169         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8170         // we're able to claim outputs on remote commitment transaction before timelocks expiration
8171
8172         // Create 2 HTLCs
8173         // Provide preimage for one
8174         // Check aggregation
8175
8176         let chanmon_cfgs = create_chanmon_cfgs(2);
8177         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8178         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8179         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8180
8181         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8182         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8183         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8184
8185         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8186         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8187         assert_eq!(remote_txn[0].output.len(), 4);
8188         assert_eq!(remote_txn[0].input.len(), 1);
8189         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8190
8191         // Claim a HTLC without revocation (provide B monitor with preimage)
8192         nodes[1].node.claim_funds(payment_preimage);
8193         mine_transaction(&nodes[1], &remote_txn[0]);
8194         check_added_monitors!(nodes[1], 2);
8195         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
8196
8197         // One or more claim tx should have been broadcast, check it
8198         let timeout;
8199         let preimage;
8200         let preimage_bump;
8201         let feerate_timeout;
8202         let feerate_preimage;
8203         {
8204                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8205                 // 9 transactions including:
8206                 // 1*2 ChannelManager local broadcasts of commitment + HTLC-Success
8207                 // 1*3 ChannelManager local broadcasts of commitment + HTLC-Success + HTLC-Timeout
8208                 // 2 * HTLC-Success (one RBF bump we'll check later)
8209                 // 1 * HTLC-Timeout
8210                 assert_eq!(node_txn.len(), 8);
8211                 assert_eq!(node_txn[0].input.len(), 1);
8212                 assert_eq!(node_txn[6].input.len(), 1);
8213                 check_spends!(node_txn[0], remote_txn[0]);
8214                 check_spends!(node_txn[6], remote_txn[0]);
8215                 assert_eq!(node_txn[0].input[0].previous_output, node_txn[3].input[0].previous_output);
8216                 preimage_bump = node_txn[3].clone();
8217
8218                 check_spends!(node_txn[1], chan.3);
8219                 check_spends!(node_txn[2], node_txn[1]);
8220                 assert_eq!(node_txn[1], node_txn[4]);
8221                 assert_eq!(node_txn[2], node_txn[5]);
8222
8223                 timeout = node_txn[6].txid();
8224                 let index = node_txn[6].input[0].previous_output.vout;
8225                 let fee = remote_txn[0].output[index as usize].value - node_txn[6].output[0].value;
8226                 feerate_timeout = fee * 1000 / node_txn[6].get_weight() as u64;
8227
8228                 preimage = node_txn[0].txid();
8229                 let index = node_txn[0].input[0].previous_output.vout;
8230                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8231                 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8232
8233                 node_txn.clear();
8234         };
8235         assert_ne!(feerate_timeout, 0);
8236         assert_ne!(feerate_preimage, 0);
8237
8238         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8239         connect_blocks(&nodes[1], 15);
8240         {
8241                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8242                 assert_eq!(node_txn.len(), 1);
8243                 assert_eq!(node_txn[0].input.len(), 1);
8244                 assert_eq!(preimage_bump.input.len(), 1);
8245                 check_spends!(node_txn[0], remote_txn[0]);
8246                 check_spends!(preimage_bump, remote_txn[0]);
8247
8248                 let index = preimage_bump.input[0].previous_output.vout;
8249                 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
8250                 let new_feerate = fee * 1000 / preimage_bump.get_weight() as u64;
8251                 assert!(new_feerate * 100 > feerate_timeout * 125);
8252                 assert_ne!(timeout, preimage_bump.txid());
8253
8254                 let index = node_txn[0].input[0].previous_output.vout;
8255                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8256                 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8257                 assert!(new_feerate * 100 > feerate_preimage * 125);
8258                 assert_ne!(preimage, node_txn[0].txid());
8259
8260                 node_txn.clear();
8261         }
8262
8263         nodes[1].node.get_and_clear_pending_events();
8264         nodes[1].node.get_and_clear_pending_msg_events();
8265 }
8266
8267 #[test]
8268 fn test_counterparty_raa_skip_no_crash() {
8269         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8270         // commitment transaction, we would have happily carried on and provided them the next
8271         // commitment transaction based on one RAA forward. This would probably eventually have led to
8272         // channel closure, but it would not have resulted in funds loss. Still, our
8273         // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
8274         // check simply that the channel is closed in response to such an RAA, but don't check whether
8275         // we decide to punish our counterparty for revoking their funds (as we don't currently
8276         // implement that).
8277         let chanmon_cfgs = create_chanmon_cfgs(2);
8278         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8279         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8280         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8281         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8282
8283         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8284         let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8285         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8286         let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8287         // Must revoke without gaps
8288         keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8289         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8290                 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8291
8292         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8293                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8294         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8295         check_added_monitors!(nodes[1], 1);
8296 }
8297
8298 #[test]
8299 fn test_bump_txn_sanitize_tracking_maps() {
8300         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8301         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8302
8303         let chanmon_cfgs = create_chanmon_cfgs(2);
8304         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8305         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8306         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8307
8308         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8309         // Lock HTLC in both directions
8310         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8311         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8312
8313         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8314         assert_eq!(revoked_local_txn[0].input.len(), 1);
8315         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8316
8317         // Revoke local commitment tx
8318         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8319
8320         // Broadcast set of revoked txn on A
8321         connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8322         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8323         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8324
8325         mine_transaction(&nodes[0], &revoked_local_txn[0]);
8326         check_closed_broadcast!(nodes[0], true);
8327         check_added_monitors!(nodes[0], 1);
8328         let penalty_txn = {
8329                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8330                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8331                 check_spends!(node_txn[0], revoked_local_txn[0]);
8332                 check_spends!(node_txn[1], revoked_local_txn[0]);
8333                 check_spends!(node_txn[2], revoked_local_txn[0]);
8334                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8335                 node_txn.clear();
8336                 penalty_txn
8337         };
8338         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8339         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8340         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8341         {
8342                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8343                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8344                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8345                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8346                 }
8347         }
8348 }
8349
8350 #[test]
8351 fn test_override_channel_config() {
8352         let chanmon_cfgs = create_chanmon_cfgs(2);
8353         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8354         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8355         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8356
8357         // Node0 initiates a channel to node1 using the override config.
8358         let mut override_config = UserConfig::default();
8359         override_config.own_channel_config.our_to_self_delay = 200;
8360
8361         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8362
8363         // Assert the channel created by node0 is using the override config.
8364         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8365         assert_eq!(res.channel_flags, 0);
8366         assert_eq!(res.to_self_delay, 200);
8367 }
8368
8369 #[test]
8370 fn test_override_0msat_htlc_minimum() {
8371         let mut zero_config = UserConfig::default();
8372         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8373         let chanmon_cfgs = create_chanmon_cfgs(2);
8374         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8375         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8376         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8377
8378         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8379         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8380         assert_eq!(res.htlc_minimum_msat, 1);
8381
8382         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8383         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8384         assert_eq!(res.htlc_minimum_msat, 1);
8385 }
8386
8387 #[test]
8388 fn test_simple_mpp() {
8389         // Simple test of sending a multi-path payment.
8390         let chanmon_cfgs = create_chanmon_cfgs(4);
8391         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8392         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8393         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8394
8395         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8396         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8397         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8398         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8399         let logger = test_utils::TestLogger::new();
8400
8401         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8402         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8403         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();
8404         let path = route.paths[0].clone();
8405         route.paths.push(path);
8406         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8407         route.paths[0][0].short_channel_id = chan_1_id;
8408         route.paths[0][1].short_channel_id = chan_3_id;
8409         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8410         route.paths[1][0].short_channel_id = chan_2_id;
8411         route.paths[1][1].short_channel_id = chan_4_id;
8412         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8413         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8414 }
8415
8416 #[test]
8417 fn test_preimage_storage() {
8418         // Simple test of payment preimage storage allowing no client-side storage to claim payments
8419         let chanmon_cfgs = create_chanmon_cfgs(2);
8420         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8421         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8422         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8423
8424         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8425
8426         {
8427                 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8428
8429                 let logger = test_utils::TestLogger::new();
8430                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8431                 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();
8432                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8433                 check_added_monitors!(nodes[0], 1);
8434                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8435                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8436                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8437                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8438         }
8439         // Note that after leaving the above scope we have no knowledge of any arguments or return
8440         // values from previous calls.
8441         expect_pending_htlcs_forwardable!(nodes[1]);
8442         let events = nodes[1].node.get_and_clear_pending_events();
8443         assert_eq!(events.len(), 1);
8444         match events[0] {
8445                 Event::PaymentReceived { payment_preimage, user_payment_id, .. } => {
8446                         assert_eq!(user_payment_id, 42);
8447                         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8448                 },
8449                 _ => panic!("Unexpected event"),
8450         }
8451 }
8452
8453 #[test]
8454 fn test_secret_timeout() {
8455         // Simple test of payment secret storage time outs
8456         let chanmon_cfgs = create_chanmon_cfgs(2);
8457         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8458         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8459         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8460
8461         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8462
8463         let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8464
8465         // We should fail to register the same payment hash twice, at least until we've connected a
8466         // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8467         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8468                 assert_eq!(err, "Duplicate payment hash");
8469         } else { panic!(); }
8470         let mut block = {
8471                 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8472                 Block {
8473                         header: BlockHeader {
8474                                 version: 0x2000000,
8475                                 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8476                                 merkle_root: Default::default(),
8477                                 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8478                         txdata: vec![],
8479                 }
8480         };
8481         connect_block(&nodes[1], &block);
8482         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8483                 assert_eq!(err, "Duplicate payment hash");
8484         } else { panic!(); }
8485
8486         // If we then connect the second block, we should be able to register the same payment hash
8487         // again with a different user_payment_id (this time getting a new payment secret).
8488         block.header.prev_blockhash = block.header.block_hash();
8489         block.header.time += 1;
8490         connect_block(&nodes[1], &block);
8491         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8492         assert_ne!(payment_secret_1, our_payment_secret);
8493
8494         {
8495                 let logger = test_utils::TestLogger::new();
8496                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8497                 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();
8498                 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8499                 check_added_monitors!(nodes[0], 1);
8500                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8501                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8502                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8503                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8504         }
8505         // Note that after leaving the above scope we have no knowledge of any arguments or return
8506         // values from previous calls.
8507         expect_pending_htlcs_forwardable!(nodes[1]);
8508         let events = nodes[1].node.get_and_clear_pending_events();
8509         assert_eq!(events.len(), 1);
8510         match events[0] {
8511                 Event::PaymentReceived { payment_preimage, payment_secret, user_payment_id, .. } => {
8512                         assert!(payment_preimage.is_none());
8513                         assert_eq!(user_payment_id, 42);
8514                         assert_eq!(payment_secret, our_payment_secret);
8515                         // We don't actually have the payment preimage with which to claim this payment!
8516                 },
8517                 _ => panic!("Unexpected event"),
8518         }
8519 }
8520
8521 #[test]
8522 fn test_bad_secret_hash() {
8523         // Simple test of unregistered payment hash/invalid payment secret handling
8524         let chanmon_cfgs = create_chanmon_cfgs(2);
8525         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8526         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8527         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8528
8529         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8530
8531         let random_payment_hash = PaymentHash([42; 32]);
8532         let random_payment_secret = PaymentSecret([43; 32]);
8533         let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8534
8535         let logger = test_utils::TestLogger::new();
8536         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8537         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();
8538
8539         // All the below cases should end up being handled exactly identically, so we macro the
8540         // resulting events.
8541         macro_rules! handle_unknown_invalid_payment_data {
8542                 () => {
8543                         check_added_monitors!(nodes[0], 1);
8544                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8545                         let payment_event = SendEvent::from_event(events.pop().unwrap());
8546                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8547                         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8548
8549                         // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8550                         // again to process the pending backwards-failure of the HTLC
8551                         expect_pending_htlcs_forwardable!(nodes[1]);
8552                         expect_pending_htlcs_forwardable!(nodes[1]);
8553                         check_added_monitors!(nodes[1], 1);
8554
8555                         // We should fail the payment back
8556                         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8557                         match events.pop().unwrap() {
8558                                 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8559                                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8560                                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8561                                 },
8562                                 _ => panic!("Unexpected event"),
8563                         }
8564                 }
8565         }
8566
8567         let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8568         // Error data is the HTLC value (100,000) and current block height
8569         let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8570
8571         // Send a payment with the right payment hash but the wrong payment secret
8572         nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8573         handle_unknown_invalid_payment_data!();
8574         expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8575
8576         // Send a payment with a random payment hash, but the right payment secret
8577         nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8578         handle_unknown_invalid_payment_data!();
8579         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8580
8581         // Send a payment with a random payment hash and random payment secret
8582         nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8583         handle_unknown_invalid_payment_data!();
8584         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8585 }
8586
8587 #[test]
8588 fn test_update_err_monitor_lockdown() {
8589         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8590         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8591         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8592         //
8593         // This scenario may happen in a watchtower setup, where watchtower process a block height
8594         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8595         // commitment at same time.
8596
8597         let chanmon_cfgs = create_chanmon_cfgs(2);
8598         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8599         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8600         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8601
8602         // Create some initial channel
8603         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8604         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8605
8606         // Rebalance the network to generate htlc in the two directions
8607         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8608
8609         // Route a HTLC from node 0 to node 1 (but don't settle)
8610         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8611
8612         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8613         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8614         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8615         let persister = test_utils::TestPersister::new();
8616         let watchtower = {
8617                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8618                 let monitor = monitors.get(&outpoint).unwrap();
8619                 let mut w = test_utils::TestVecWriter(Vec::new());
8620                 monitor.write(&mut w).unwrap();
8621                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8622                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8623                 assert!(new_monitor == *monitor);
8624                 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);
8625                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8626                 watchtower
8627         };
8628         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8629         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8630         // transaction lock time requirements here.
8631         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (header, 0));
8632         watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8633
8634         // Try to update ChannelMonitor
8635         assert!(nodes[1].node.claim_funds(preimage));
8636         check_added_monitors!(nodes[1], 1);
8637         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8638         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8639         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8640         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8641                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8642                         if let Err(_) =  watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8643                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8644                 } else { assert!(false); }
8645         } else { assert!(false); };
8646         // Our local monitor is in-sync and hasn't processed yet timeout
8647         check_added_monitors!(nodes[0], 1);
8648         let events = nodes[0].node.get_and_clear_pending_events();
8649         assert_eq!(events.len(), 1);
8650 }
8651
8652 #[test]
8653 fn test_concurrent_monitor_claim() {
8654         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8655         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8656         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8657         // state N+1 confirms. Alice claims output from state N+1.
8658
8659         let chanmon_cfgs = create_chanmon_cfgs(2);
8660         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8661         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8662         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8663
8664         // Create some initial channel
8665         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8666         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8667
8668         // Rebalance the network to generate htlc in the two directions
8669         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8670
8671         // Route a HTLC from node 0 to node 1 (but don't settle)
8672         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8673
8674         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8675         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8676         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8677         let persister = test_utils::TestPersister::new();
8678         let watchtower_alice = {
8679                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8680                 let monitor = monitors.get(&outpoint).unwrap();
8681                 let mut w = test_utils::TestVecWriter(Vec::new());
8682                 monitor.write(&mut w).unwrap();
8683                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8684                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8685                 assert!(new_monitor == *monitor);
8686                 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);
8687                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8688                 watchtower
8689         };
8690         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8691         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8692         // transaction lock time requirements here.
8693         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (header, 0));
8694         watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8695
8696         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8697         {
8698                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8699                 assert_eq!(txn.len(), 2);
8700                 txn.clear();
8701         }
8702
8703         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8704         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8705         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8706         let persister = test_utils::TestPersister::new();
8707         let watchtower_bob = {
8708                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8709                 let monitor = monitors.get(&outpoint).unwrap();
8710                 let mut w = test_utils::TestVecWriter(Vec::new());
8711                 monitor.write(&mut w).unwrap();
8712                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8713                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8714                 assert!(new_monitor == *monitor);
8715                 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);
8716                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8717                 watchtower
8718         };
8719         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8720         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8721
8722         // Route another payment to generate another update with still previous HTLC pending
8723         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8724         {
8725                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8726                 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();
8727                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8728         }
8729         check_added_monitors!(nodes[1], 1);
8730
8731         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8732         assert_eq!(updates.update_add_htlcs.len(), 1);
8733         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8734         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8735                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8736                         // Watchtower Alice should already have seen the block and reject the update
8737                         if let Err(_) =  watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8738                         if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8739                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8740                 } else { assert!(false); }
8741         } else { assert!(false); };
8742         // Our local monitor is in-sync and hasn't processed yet timeout
8743         check_added_monitors!(nodes[0], 1);
8744
8745         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8746         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8747         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8748
8749         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8750         let bob_state_y;
8751         {
8752                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8753                 assert_eq!(txn.len(), 2);
8754                 bob_state_y = txn[0].clone();
8755                 txn.clear();
8756         };
8757
8758         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8759         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8760         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);
8761         {
8762                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8763                 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8764                 // the onchain detection of the HTLC output
8765                 assert_eq!(htlc_txn.len(), 2);
8766                 check_spends!(htlc_txn[0], bob_state_y);
8767                 check_spends!(htlc_txn[1], bob_state_y);
8768         }
8769 }
8770
8771 #[test]
8772 fn test_pre_lockin_no_chan_closed_update() {
8773         // Test that if a peer closes a channel in response to a funding_created message we don't
8774         // generate a channel update (as the channel cannot appear on chain without a funding_signed
8775         // message).
8776         //
8777         // Doing so would imply a channel monitor update before the initial channel monitor
8778         // registration, violating our API guarantees.
8779         //
8780         // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8781         // then opening a second channel with the same funding output as the first (which is not
8782         // rejected because the first channel does not exist in the ChannelManager) and closing it
8783         // before receiving funding_signed.
8784         let chanmon_cfgs = create_chanmon_cfgs(2);
8785         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8786         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8787         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8788
8789         // Create an initial channel
8790         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8791         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8792         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8793         let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8794         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8795
8796         // Move the first channel through the funding flow...
8797         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8798
8799         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8800         check_added_monitors!(nodes[0], 0);
8801
8802         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8803         let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8804         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8805         assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8806 }
8807
8808 #[test]
8809 fn test_htlc_no_detection() {
8810         // This test is a mutation to underscore the detection logic bug we had
8811         // before #653. HTLC value routed is above the remaining balance, thus
8812         // inverting HTLC and `to_remote` output. HTLC will come second and
8813         // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8814         // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8815         // outputs order detection for correct spending children filtring.
8816
8817         let chanmon_cfgs = create_chanmon_cfgs(2);
8818         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8819         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8820         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8821
8822         // Create some initial channels
8823         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8824
8825         send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8826         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8827         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8828         assert_eq!(local_txn[0].input.len(), 1);
8829         assert_eq!(local_txn[0].output.len(), 3);
8830         check_spends!(local_txn[0], chan_1.3);
8831
8832         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8833         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8834         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8835         // We deliberately connect the local tx twice as this should provoke a failure calling
8836         // this test before #653 fix.
8837         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);
8838         check_closed_broadcast!(nodes[0], true);
8839         check_added_monitors!(nodes[0], 1);
8840         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
8841
8842         let htlc_timeout = {
8843                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8844                 assert_eq!(node_txn[1].input.len(), 1);
8845                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8846                 check_spends!(node_txn[1], local_txn[0]);
8847                 node_txn[1].clone()
8848         };
8849
8850         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8851         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8852         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8853         expect_payment_failed!(nodes[0], our_payment_hash, true);
8854 }
8855
8856 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8857         // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8858         // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8859         // Carol, Alice would be the upstream node, and Carol the downstream.)
8860         //
8861         // Steps of the test:
8862         // 1) Alice sends a HTLC to Carol through Bob.
8863         // 2) Carol doesn't settle the HTLC.
8864         // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8865         // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8866         // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8867         //    but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8868         // 5) Carol release the preimage to Bob off-chain.
8869         // 6) Bob claims the offered output on the broadcasted commitment.
8870         let chanmon_cfgs = create_chanmon_cfgs(3);
8871         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8872         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8873         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8874
8875         // Create some initial channels
8876         let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8877         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8878
8879         // Steps (1) and (2):
8880         // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8881         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8882
8883         // Check that Alice's commitment transaction now contains an output for this HTLC.
8884         let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8885         check_spends!(alice_txn[0], chan_ab.3);
8886         assert_eq!(alice_txn[0].output.len(), 2);
8887         check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8888         assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8889         assert_eq!(alice_txn.len(), 2);
8890
8891         // Steps (3) and (4):
8892         // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8893         // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8894         let mut force_closing_node = 0; // Alice force-closes
8895         if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8896         nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8897         check_closed_broadcast!(nodes[force_closing_node], true);
8898         check_added_monitors!(nodes[force_closing_node], 1);
8899         if go_onchain_before_fulfill {
8900                 let txn_to_broadcast = match broadcast_alice {
8901                         true => alice_txn.clone(),
8902                         false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8903                 };
8904                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8905                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8906                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8907                 if broadcast_alice {
8908                         check_closed_broadcast!(nodes[1], true);
8909                         check_added_monitors!(nodes[1], 1);
8910                 }
8911                 assert_eq!(bob_txn.len(), 1);
8912                 check_spends!(bob_txn[0], chan_ab.3);
8913         }
8914
8915         // Step (5):
8916         // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8917         // process of removing the HTLC from their commitment transactions.
8918         assert!(nodes[2].node.claim_funds(payment_preimage));
8919         check_added_monitors!(nodes[2], 1);
8920         let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8921         assert!(carol_updates.update_add_htlcs.is_empty());
8922         assert!(carol_updates.update_fail_htlcs.is_empty());
8923         assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8924         assert!(carol_updates.update_fee.is_none());
8925         assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8926
8927         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8928         // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8929         if !go_onchain_before_fulfill && broadcast_alice {
8930                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8931                 assert_eq!(events.len(), 1);
8932                 match events[0] {
8933                         MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8934                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8935                         },
8936                         _ => panic!("Unexpected event"),
8937                 };
8938         }
8939         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8940         // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8941         // Carol<->Bob's updated commitment transaction info.
8942         check_added_monitors!(nodes[1], 2);
8943
8944         let events = nodes[1].node.get_and_clear_pending_msg_events();
8945         assert_eq!(events.len(), 2);
8946         let bob_revocation = match events[0] {
8947                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8948                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8949                         (*msg).clone()
8950                 },
8951                 _ => panic!("Unexpected event"),
8952         };
8953         let bob_updates = match events[1] {
8954                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8955                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8956                         (*updates).clone()
8957                 },
8958                 _ => panic!("Unexpected event"),
8959         };
8960
8961         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8962         check_added_monitors!(nodes[2], 1);
8963         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8964         check_added_monitors!(nodes[2], 1);
8965
8966         let events = nodes[2].node.get_and_clear_pending_msg_events();
8967         assert_eq!(events.len(), 1);
8968         let carol_revocation = match events[0] {
8969                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8970                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8971                         (*msg).clone()
8972                 },
8973                 _ => panic!("Unexpected event"),
8974         };
8975         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8976         check_added_monitors!(nodes[1], 1);
8977
8978         // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8979         // here's where we put said channel's commitment tx on-chain.
8980         let mut txn_to_broadcast = alice_txn.clone();
8981         if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8982         if !go_onchain_before_fulfill {
8983                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8984                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8985                 // If Bob was the one to force-close, he will have already passed these checks earlier.
8986                 if broadcast_alice {
8987                         check_closed_broadcast!(nodes[1], true);
8988                         check_added_monitors!(nodes[1], 1);
8989                 }
8990                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8991                 if broadcast_alice {
8992                         // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8993                         // new block being connected. The ChannelManager being notified triggers a monitor update,
8994                         // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8995                         // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8996                         // broadcasted.
8997                         assert_eq!(bob_txn.len(), 3);
8998                         check_spends!(bob_txn[1], chan_ab.3);
8999                 } else {
9000                         assert_eq!(bob_txn.len(), 2);
9001                         check_spends!(bob_txn[0], chan_ab.3);
9002                 }
9003         }
9004
9005         // Step (6):
9006         // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
9007         // broadcasted commitment transaction.
9008         {
9009                 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
9010                 if go_onchain_before_fulfill {
9011                         // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
9012                         assert_eq!(bob_txn.len(), 2);
9013                 }
9014                 let script_weight = match broadcast_alice {
9015                         true => OFFERED_HTLC_SCRIPT_WEIGHT,
9016                         false => ACCEPTED_HTLC_SCRIPT_WEIGHT
9017                 };
9018                 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
9019                 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
9020                 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
9021                 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
9022                 if broadcast_alice && !go_onchain_before_fulfill {
9023                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
9024                         assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
9025                 } else {
9026                         check_spends!(bob_txn[1], txn_to_broadcast[0]);
9027                         assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
9028                 }
9029         }
9030 }
9031
9032 #[test]
9033 fn test_onchain_htlc_settlement_after_close() {
9034         do_test_onchain_htlc_settlement_after_close(true, true);
9035         do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
9036         do_test_onchain_htlc_settlement_after_close(true, false);
9037         do_test_onchain_htlc_settlement_after_close(false, false);
9038 }
9039
9040 #[test]
9041 fn test_duplicate_chan_id() {
9042         // Test that if a given peer tries to open a channel with the same channel_id as one that is
9043         // already open we reject it and keep the old channel.
9044         //
9045         // Previously, full_stack_target managed to figure out that if you tried to open two channels
9046         // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
9047         // the existing channel when we detect the duplicate new channel, screwing up our monitor
9048         // updating logic for the existing channel.
9049         let chanmon_cfgs = create_chanmon_cfgs(2);
9050         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9051         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9052         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9053
9054         // Create an initial channel
9055         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9056         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9057         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9058         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()));
9059
9060         // Try to create a second channel with the same temporary_channel_id as the first and check
9061         // that it is rejected.
9062         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9063         {
9064                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9065                 assert_eq!(events.len(), 1);
9066                 match events[0] {
9067                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9068                                 // Technically, at this point, nodes[1] would be justified in thinking both the
9069                                 // first (valid) and second (invalid) channels are closed, given they both have
9070                                 // the same non-temporary channel_id. However, currently we do not, so we just
9071                                 // move forward with it.
9072                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9073                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9074                         },
9075                         _ => panic!("Unexpected event"),
9076                 }
9077         }
9078
9079         // Move the first channel through the funding flow...
9080         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
9081
9082         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9083         check_added_monitors!(nodes[0], 0);
9084
9085         let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9086         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9087         {
9088                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9089                 assert_eq!(added_monitors.len(), 1);
9090                 assert_eq!(added_monitors[0].0, funding_output);
9091                 added_monitors.clear();
9092         }
9093         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9094
9095         let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
9096         let channel_id = funding_outpoint.to_channel_id();
9097
9098         // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
9099         // temporary one).
9100
9101         // First try to open a second channel with a temporary channel id equal to the txid-based one.
9102         // Technically this is allowed by the spec, but we don't support it and there's little reason
9103         // to. Still, it shouldn't cause any other issues.
9104         open_chan_msg.temporary_channel_id = channel_id;
9105         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9106         {
9107                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9108                 assert_eq!(events.len(), 1);
9109                 match events[0] {
9110                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9111                                 // Technically, at this point, nodes[1] would be justified in thinking both
9112                                 // channels are closed, but currently we do not, so we just move forward with it.
9113                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9114                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9115                         },
9116                         _ => panic!("Unexpected event"),
9117                 }
9118         }
9119
9120         // Now try to create a second channel which has a duplicate funding output.
9121         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9122         let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9123         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
9124         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()));
9125         create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
9126
9127         let funding_created = {
9128                 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
9129                 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
9130                 let logger = test_utils::TestLogger::new();
9131                 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
9132         };
9133         check_added_monitors!(nodes[0], 0);
9134         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
9135         // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
9136         // still needs to be cleared here.
9137         check_added_monitors!(nodes[1], 1);
9138
9139         // ...still, nodes[1] will reject the duplicate channel.
9140         {
9141                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9142                 assert_eq!(events.len(), 1);
9143                 match events[0] {
9144                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9145                                 // Technically, at this point, nodes[1] would be justified in thinking both
9146                                 // channels are closed, but currently we do not, so we just move forward with it.
9147                                 assert_eq!(msg.channel_id, channel_id);
9148                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9149                         },
9150                         _ => panic!("Unexpected event"),
9151                 }
9152         }
9153
9154         // finally, finish creating the original channel and send a payment over it to make sure
9155         // everything is functional.
9156         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9157         {
9158                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9159                 assert_eq!(added_monitors.len(), 1);
9160                 assert_eq!(added_monitors[0].0, funding_output);
9161                 added_monitors.clear();
9162         }
9163
9164         let events_4 = nodes[0].node.get_and_clear_pending_events();
9165         assert_eq!(events_4.len(), 0);
9166         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9167         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
9168
9169         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9170         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9171         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9172         send_payment(&nodes[0], &[&nodes[1]], 8000000);
9173 }
9174
9175 #[test]
9176 fn test_error_chans_closed() {
9177         // Test that we properly handle error messages, closing appropriate channels.
9178         //
9179         // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9180         // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9181         // we can test various edge cases around it to ensure we don't regress.
9182         let chanmon_cfgs = create_chanmon_cfgs(3);
9183         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9184         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9185         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9186
9187         // Create some initial channels
9188         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9189         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9190         let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9191
9192         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9193         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9194         assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9195
9196         // Closing a channel from a different peer has no effect
9197         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9198         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9199
9200         // Closing one channel doesn't impact others
9201         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9202         check_added_monitors!(nodes[0], 1);
9203         check_closed_broadcast!(nodes[0], false);
9204         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9205         assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9206         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);
9207         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);
9208
9209         // A null channel ID should close all channels
9210         let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9211         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9212         check_added_monitors!(nodes[0], 2);
9213         let events = nodes[0].node.get_and_clear_pending_msg_events();
9214         assert_eq!(events.len(), 2);
9215         match events[0] {
9216                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9217                         assert_eq!(msg.contents.flags & 2, 2);
9218                 },
9219                 _ => panic!("Unexpected event"),
9220         }
9221         match events[1] {
9222                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9223                         assert_eq!(msg.contents.flags & 2, 2);
9224                 },
9225                 _ => panic!("Unexpected event"),
9226         }
9227         // Note that at this point users of a standard PeerHandler will end up calling
9228         // peer_disconnected with no_connection_possible set to false, duplicating the
9229         // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9230         // users with their own peer handling logic. We duplicate the call here, however.
9231         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9232         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9233
9234         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9235         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9236         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9237 }
9238
9239 #[test]
9240 fn test_invalid_funding_tx() {
9241         // Test that we properly handle invalid funding transactions sent to us from a peer.
9242         //
9243         // Previously, all other major lightning implementations had failed to properly sanitize
9244         // funding transactions from their counterparties, leading to a multi-implementation critical
9245         // security vulnerability (though we always sanitized properly, we've previously had
9246         // un-released crashes in the sanitization process).
9247         let chanmon_cfgs = create_chanmon_cfgs(2);
9248         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9249         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9250         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9251
9252         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9253         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()));
9254         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()));
9255
9256         let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9257         for output in tx.output.iter_mut() {
9258                 // Make the confirmed funding transaction have a bogus script_pubkey
9259                 output.script_pubkey = bitcoin::Script::new();
9260         }
9261
9262         nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9263         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()));
9264         check_added_monitors!(nodes[1], 1);
9265
9266         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()));
9267         check_added_monitors!(nodes[0], 1);
9268
9269         let events_1 = nodes[0].node.get_and_clear_pending_events();
9270         assert_eq!(events_1.len(), 0);
9271
9272         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9273         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9274         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9275
9276         confirm_transaction_at(&nodes[1], &tx, 1);
9277         check_added_monitors!(nodes[1], 1);
9278         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9279         assert_eq!(events_2.len(), 1);
9280         if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9281                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9282                 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9283                         assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9284                 } else { panic!(); }
9285         } else { panic!(); }
9286         assert_eq!(nodes[1].node.list_channels().len(), 0);
9287 }