_ 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(), 9);
1504         assert_eq!(claim_txn[1], claim_txn[5]);
1505         assert_eq!(claim_txn[2], claim_txn[6]);
1506         assert_eq!(claim_txn[3], claim_txn[8]);
1507         check_spends!(claim_txn[1], chan_1.3);
1508         check_spends!(claim_txn[2], claim_txn[1]);
1509         check_spends!(claim_txn[3], claim_txn[1]);
1510
1511         assert_eq!(claim_txn[0].input.len(), 1);
1512         assert_eq!(claim_txn[4].input.len(), 1);
1513         assert_eq!(claim_txn[0].input[0].previous_output, claim_txn[4].input[0].previous_output);
1514
1515         assert_eq!(claim_txn[0].input.len(), 1);
1516         assert_eq!(claim_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1517         check_spends!(claim_txn[0], remote_txn[0]);
1518         assert_eq!(remote_txn[0].output[claim_txn[0].input[0].previous_output.vout as usize].value, 800);
1519         assert_eq!(claim_txn[7].input.len(), 1);
1520         assert_eq!(claim_txn[7].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1521         check_spends!(claim_txn[7], remote_txn[0]);
1522         assert_eq!(remote_txn[0].output[claim_txn[7].input[0].previous_output.vout as usize].value, 900);
1523
1524         let events = nodes[0].node.get_and_clear_pending_msg_events();
1525         assert_eq!(events.len(), 3);
1526         for e in events {
1527                 match e {
1528                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1529                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1530                                 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1531                                 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1532                         },
1533                         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, .. } } => {
1534                                 assert!(update_add_htlcs.is_empty());
1535                                 assert!(update_fail_htlcs.is_empty());
1536                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1537                                 assert!(update_fail_malformed_htlcs.is_empty());
1538                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1539                         },
1540                         _ => panic!("Unexpected event"),
1541                 }
1542         }
1543 }
1544
1545 #[test]
1546 fn test_basic_channel_reserve() {
1547         let chanmon_cfgs = create_chanmon_cfgs(2);
1548         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1549         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1550         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1551         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1552         let logger = test_utils::TestLogger::new();
1553
1554         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1555         let channel_reserve = chan_stat.channel_reserve_msat;
1556
1557         // The 2* and +1 are for the fee spike reserve.
1558         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
1559         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1560         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1561         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1562         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();
1563         let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).err().unwrap();
1564         match err {
1565                 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1566                         match &fails[0] {
1567                                 &APIError::ChannelUnavailable{ref err} =>
1568                                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1569                                 _ => panic!("Unexpected error variant"),
1570                         }
1571                 },
1572                 _ => panic!("Unexpected error variant"),
1573         }
1574         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1575         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);
1576
1577         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1578 }
1579
1580 #[test]
1581 fn test_fee_spike_violation_fails_htlc() {
1582         let chanmon_cfgs = create_chanmon_cfgs(2);
1583         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1584         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1585         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1586         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1587
1588         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1589         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1590         let secp_ctx = Secp256k1::new();
1591         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1592
1593         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1594
1595         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1596         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height).unwrap();
1597         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1598         let msg = msgs::UpdateAddHTLC {
1599                 channel_id: chan.2,
1600                 htlc_id: 0,
1601                 amount_msat: htlc_msat,
1602                 payment_hash: payment_hash,
1603                 cltv_expiry: htlc_cltv,
1604                 onion_routing_packet: onion_packet,
1605         };
1606
1607         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1608
1609         // Now manually create the commitment_signed message corresponding to the update_add
1610         // nodes[0] just sent. In the code for construction of this message, "local" refers
1611         // to the sender of the message, and "remote" refers to the receiver.
1612
1613         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1614
1615         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1616
1617         // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1618         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1619         let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point) = {
1620                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1621                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1622                 let chan_signer = local_chan.get_signer();
1623                 let pubkeys = chan_signer.pubkeys();
1624                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1625                  chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1626                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx))
1627         };
1628         let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point) = {
1629                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1630                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1631                 let chan_signer = remote_chan.get_signer();
1632                 let pubkeys = chan_signer.pubkeys();
1633                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1634                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx))
1635         };
1636
1637         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1638         let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1639                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1640
1641         // Build the remote commitment transaction so we can sign it, and then later use the
1642         // signature for the commitment_signed message.
1643         let local_chan_balance = 1313;
1644
1645         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1646                 offered: false,
1647                 amount_msat: 3460001,
1648                 cltv_expiry: htlc_cltv,
1649                 payment_hash,
1650                 transaction_output_index: Some(1),
1651         };
1652
1653         let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1654
1655         let res = {
1656                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1657                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1658                 let local_chan_signer = local_chan.get_signer();
1659                 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1660                         commitment_number,
1661                         95000,
1662                         local_chan_balance,
1663                         commit_tx_keys.clone(),
1664                         feerate_per_kw,
1665                         &mut vec![(accepted_htlc_info, ())],
1666                         &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1667                 );
1668                 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1669         };
1670
1671         let commit_signed_msg = msgs::CommitmentSigned {
1672                 channel_id: chan.2,
1673                 signature: res.0,
1674                 htlc_signatures: res.1
1675         };
1676
1677         // Send the commitment_signed message to the nodes[1].
1678         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1679         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1680
1681         // Send the RAA to nodes[1].
1682         let raa_msg = msgs::RevokeAndACK {
1683                 channel_id: chan.2,
1684                 per_commitment_secret: local_secret,
1685                 next_per_commitment_point: next_local_point
1686         };
1687         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1688
1689         let events = nodes[1].node.get_and_clear_pending_msg_events();
1690         assert_eq!(events.len(), 1);
1691         // Make sure the HTLC failed in the way we expect.
1692         match events[0] {
1693                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1694                         assert_eq!(update_fail_htlcs.len(), 1);
1695                         update_fail_htlcs[0].clone()
1696                 },
1697                 _ => panic!("Unexpected event"),
1698         };
1699         nodes[1].logger.assert_log("lightning::ln::channel".to_string(), "Attempting to fail HTLC due to fee spike buffer violation".to_string(), 1);
1700
1701         check_added_monitors!(nodes[1], 2);
1702 }
1703
1704 #[test]
1705 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1706         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1707         // Set the fee rate for the channel very high, to the point where the fundee
1708         // sending any above-dust amount would result in a channel reserve violation.
1709         // In this test we check that we would be prevented from sending an HTLC in
1710         // this situation.
1711         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1712         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1713         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1714         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1715         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1716         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1717
1718         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 4843000);
1719         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1720                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1721         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1722         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);
1723 }
1724
1725 #[test]
1726 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1727         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1728         // Set the fee rate for the channel very high, to the point where the funder
1729         // receiving 1 update_add_htlc would result in them closing the channel due
1730         // to channel reserve violation. This close could also happen if the fee went
1731         // up a more realistic amount, but many HTLCs were outstanding at the time of
1732         // the update_add_htlc.
1733         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1734         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1735         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1736         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1737         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1738         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1739
1740         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1741         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1742         let secp_ctx = Secp256k1::new();
1743         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1744         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1745         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1746         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height).unwrap();
1747         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1748         let msg = msgs::UpdateAddHTLC {
1749                 channel_id: chan.2,
1750                 htlc_id: 1,
1751                 amount_msat: htlc_msat + 1,
1752                 payment_hash: payment_hash,
1753                 cltv_expiry: htlc_cltv,
1754                 onion_routing_packet: onion_packet,
1755         };
1756
1757         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1758         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1759         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);
1760         assert_eq!(nodes[0].node.list_channels().len(), 0);
1761         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1762         assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1763         check_added_monitors!(nodes[0], 1);
1764 }
1765
1766 #[test]
1767 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1768         // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1769         // calculating our commitment transaction fee (this was previously broken).
1770         let chanmon_cfgs = create_chanmon_cfgs(2);
1771         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1772         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1773         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1774
1775         // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1776         // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1777         // transaction fee with 0 HTLCs (183 sats)).
1778         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98817000, InitFeatures::known(), InitFeatures::known());
1779
1780         let dust_amt = 329000; // Dust amount
1781         // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1782         // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1783         // commitment transaction fee.
1784         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1785 }
1786
1787 #[test]
1788 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1789         // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1790         // calculating our counterparty's commitment transaction fee (this was previously broken).
1791         let chanmon_cfgs = create_chanmon_cfgs(2);
1792         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1793         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1794         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1795         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1796
1797         let payment_amt = 46000; // Dust amount
1798         // In the previous code, these first four payments would succeed.
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         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1803
1804         // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
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         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1810
1811         // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1812         // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1813         // transaction fee and therefore perceived this next payment as a channel reserve violation.
1814         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1815 }
1816
1817 #[test]
1818 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1819         let chanmon_cfgs = create_chanmon_cfgs(3);
1820         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1821         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1822         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1823         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1824         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1825
1826         let feemsat = 239;
1827         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1828         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1829         let feerate = get_feerate!(nodes[0], chan.2);
1830
1831         // Add a 2* and +1 for the fee spike reserve.
1832         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1833         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;
1834         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1835
1836         // Add a pending HTLC.
1837         let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1838         let payment_event_1 = {
1839                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1840                 check_added_monitors!(nodes[0], 1);
1841
1842                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1843                 assert_eq!(events.len(), 1);
1844                 SendEvent::from_event(events.remove(0))
1845         };
1846         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1847
1848         // Attempt to trigger a channel reserve violation --> payment failure.
1849         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1850         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;
1851         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1852         let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1853
1854         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1855         let secp_ctx = Secp256k1::new();
1856         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1857         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1858         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1859         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1860         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1861         let msg = msgs::UpdateAddHTLC {
1862                 channel_id: chan.2,
1863                 htlc_id: 1,
1864                 amount_msat: htlc_msat + 1,
1865                 payment_hash: our_payment_hash_1,
1866                 cltv_expiry: htlc_cltv,
1867                 onion_routing_packet: onion_packet,
1868         };
1869
1870         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1871         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1872         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1873         assert_eq!(nodes[1].node.list_channels().len(), 1);
1874         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1875         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1876         check_added_monitors!(nodes[1], 1);
1877 }
1878
1879 #[test]
1880 fn test_inbound_outbound_capacity_is_not_zero() {
1881         let chanmon_cfgs = create_chanmon_cfgs(2);
1882         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1883         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1884         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1885         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1886         let channels0 = node_chanmgrs[0].list_channels();
1887         let channels1 = node_chanmgrs[1].list_channels();
1888         assert_eq!(channels0.len(), 1);
1889         assert_eq!(channels1.len(), 1);
1890
1891         assert_eq!(channels0[0].inbound_capacity_msat, 95000000);
1892         assert_eq!(channels1[0].outbound_capacity_msat, 95000000);
1893
1894         assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000);
1895         assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000);
1896 }
1897
1898 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1899         (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1900 }
1901
1902 #[test]
1903 fn test_channel_reserve_holding_cell_htlcs() {
1904         let chanmon_cfgs = create_chanmon_cfgs(3);
1905         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1906         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1907         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1908         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1909         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1910
1911         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1912         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1913
1914         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1915         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1916
1917         macro_rules! expect_forward {
1918                 ($node: expr) => {{
1919                         let mut events = $node.node.get_and_clear_pending_msg_events();
1920                         assert_eq!(events.len(), 1);
1921                         check_added_monitors!($node, 1);
1922                         let payment_event = SendEvent::from_event(events.remove(0));
1923                         payment_event
1924                 }}
1925         }
1926
1927         let feemsat = 239; // somehow we know?
1928         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1929         let feerate = get_feerate!(nodes[0], chan_1.2);
1930
1931         let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1932
1933         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1934         {
1935                 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1936                 route.paths[0].last_mut().unwrap().fee_msat += 1;
1937                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1938                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1939                         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)));
1940                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1941                 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);
1942         }
1943
1944         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1945         // nodes[0]'s wealth
1946         loop {
1947                 let amt_msat = recv_value_0 + total_fee_msat;
1948                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1949                 // Also, ensure that each payment has enough to be over the dust limit to
1950                 // ensure it'll be included in each commit tx fee calculation.
1951                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1952                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1953                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1954                         break;
1955                 }
1956                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1957
1958                 let (stat01_, stat11_, stat12_, stat22_) = (
1959                         get_channel_value_stat!(nodes[0], chan_1.2),
1960                         get_channel_value_stat!(nodes[1], chan_1.2),
1961                         get_channel_value_stat!(nodes[1], chan_2.2),
1962                         get_channel_value_stat!(nodes[2], chan_2.2),
1963                 );
1964
1965                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1966                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1967                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1968                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1969                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1970         }
1971
1972         // adding pending output.
1973         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1974         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1975         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1976         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1977         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1978         // cases where 1 msat over X amount will cause a payment failure, but anything less than
1979         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1980         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1981         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1982         // policy.
1983         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1984         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1985         let amt_msat_1 = recv_value_1 + total_fee_msat;
1986
1987         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);
1988         let payment_event_1 = {
1989                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1990                 check_added_monitors!(nodes[0], 1);
1991
1992                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1993                 assert_eq!(events.len(), 1);
1994                 SendEvent::from_event(events.remove(0))
1995         };
1996         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1997
1998         // channel reserve test with htlc pending output > 0
1999         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
2000         {
2001                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
2002                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2003                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2004                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2005         }
2006
2007         // split the rest to test holding cell
2008         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
2009         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2010         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2011         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2012         {
2013                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2014                 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);
2015         }
2016
2017         // now see if they go through on both sides
2018         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);
2019         // but this will stuck in the holding cell
2020         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
2021         check_added_monitors!(nodes[0], 0);
2022         let events = nodes[0].node.get_and_clear_pending_events();
2023         assert_eq!(events.len(), 0);
2024
2025         // test with outbound holding cell amount > 0
2026         {
2027                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
2028                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2029                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2030                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2031                 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);
2032         }
2033
2034         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);
2035         // this will also stuck in the holding cell
2036         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
2037         check_added_monitors!(nodes[0], 0);
2038         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2039         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2040
2041         // flush the pending htlc
2042         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2043         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2044         check_added_monitors!(nodes[1], 1);
2045
2046         // the pending htlc should be promoted to committed
2047         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2048         check_added_monitors!(nodes[0], 1);
2049         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2050
2051         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2052         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2053         // No commitment_signed so get_event_msg's assert(len == 1) passes
2054         check_added_monitors!(nodes[0], 1);
2055
2056         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2057         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2058         check_added_monitors!(nodes[1], 1);
2059
2060         expect_pending_htlcs_forwardable!(nodes[1]);
2061
2062         let ref payment_event_11 = expect_forward!(nodes[1]);
2063         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2064         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2065
2066         expect_pending_htlcs_forwardable!(nodes[2]);
2067         expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
2068
2069         // flush the htlcs in the holding cell
2070         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2071         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2072         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2073         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2074         expect_pending_htlcs_forwardable!(nodes[1]);
2075
2076         let ref payment_event_3 = expect_forward!(nodes[1]);
2077         assert_eq!(payment_event_3.msgs.len(), 2);
2078         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2079         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2080
2081         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2082         expect_pending_htlcs_forwardable!(nodes[2]);
2083
2084         let events = nodes[2].node.get_and_clear_pending_events();
2085         assert_eq!(events.len(), 2);
2086         match events[0] {
2087                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2088                         assert_eq!(our_payment_hash_21, *payment_hash);
2089                         assert!(payment_preimage.is_none());
2090                         assert_eq!(our_payment_secret_21, *payment_secret);
2091                         assert_eq!(recv_value_21, amt);
2092                 },
2093                 _ => panic!("Unexpected event"),
2094         }
2095         match events[1] {
2096                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2097                         assert_eq!(our_payment_hash_22, *payment_hash);
2098                         assert!(payment_preimage.is_none());
2099                         assert_eq!(our_payment_secret_22, *payment_secret);
2100                         assert_eq!(recv_value_22, amt);
2101                 },
2102                 _ => panic!("Unexpected event"),
2103         }
2104
2105         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
2106         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
2107         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
2108
2109         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2110         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2111         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
2112
2113         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2114         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);
2115         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2116         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2117         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2118
2119         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2120         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2121 }
2122
2123 #[test]
2124 fn channel_reserve_in_flight_removes() {
2125         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2126         // can send to its counterparty, but due to update ordering, the other side may not yet have
2127         // considered those HTLCs fully removed.
2128         // This tests that we don't count HTLCs which will not be included in the next remote
2129         // commitment transaction towards the reserve value (as it implies no commitment transaction
2130         // will be generated which violates the remote reserve value).
2131         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2132         // To test this we:
2133         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2134         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2135         //    you only consider the value of the first HTLC, it may not),
2136         //  * start routing a third HTLC from A to B,
2137         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2138         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2139         //  * deliver the first fulfill from B
2140         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2141         //    claim,
2142         //  * deliver A's response CS and RAA.
2143         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2144         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
2145         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2146         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2147         let chanmon_cfgs = create_chanmon_cfgs(2);
2148         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2149         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2150         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2151         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2152         let logger = test_utils::TestLogger::new();
2153
2154         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2155         // Route the first two HTLCs.
2156         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2157         let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2158
2159         // Start routing the third HTLC (this is just used to get everyone in the right state).
2160         let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
2161         let send_1 = {
2162                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2163                 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();
2164                 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
2165                 check_added_monitors!(nodes[0], 1);
2166                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2167                 assert_eq!(events.len(), 1);
2168                 SendEvent::from_event(events.remove(0))
2169         };
2170
2171         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2172         // initial fulfill/CS.
2173         assert!(nodes[1].node.claim_funds(payment_preimage_1));
2174         check_added_monitors!(nodes[1], 1);
2175         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2176
2177         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2178         // remove the second HTLC when we send the HTLC back from B to A.
2179         assert!(nodes[1].node.claim_funds(payment_preimage_2));
2180         check_added_monitors!(nodes[1], 1);
2181         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2182
2183         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2184         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2185         check_added_monitors!(nodes[0], 1);
2186         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2187         expect_payment_sent!(nodes[0], payment_preimage_1);
2188
2189         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2190         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2191         check_added_monitors!(nodes[1], 1);
2192         // B is already AwaitingRAA, so cant generate a CS here
2193         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2194
2195         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2196         check_added_monitors!(nodes[1], 1);
2197         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2198
2199         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2200         check_added_monitors!(nodes[0], 1);
2201         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2202
2203         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2204         check_added_monitors!(nodes[1], 1);
2205         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2206
2207         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2208         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2209         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2210         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2211         // on-chain as necessary).
2212         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2213         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2214         check_added_monitors!(nodes[0], 1);
2215         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2216         expect_payment_sent!(nodes[0], payment_preimage_2);
2217
2218         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2219         check_added_monitors!(nodes[1], 1);
2220         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2221
2222         expect_pending_htlcs_forwardable!(nodes[1]);
2223         expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
2224
2225         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2226         // resolve the second HTLC from A's point of view.
2227         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2228         check_added_monitors!(nodes[0], 1);
2229         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2230
2231         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2232         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2233         let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
2234         let send_2 = {
2235                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2236                 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();
2237                 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
2238                 check_added_monitors!(nodes[1], 1);
2239                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2240                 assert_eq!(events.len(), 1);
2241                 SendEvent::from_event(events.remove(0))
2242         };
2243
2244         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2245         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2246         check_added_monitors!(nodes[0], 1);
2247         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2248
2249         // Now just resolve all the outstanding messages/HTLCs for completeness...
2250
2251         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2252         check_added_monitors!(nodes[1], 1);
2253         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2254
2255         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2256         check_added_monitors!(nodes[1], 1);
2257
2258         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2259         check_added_monitors!(nodes[0], 1);
2260         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2261
2262         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2263         check_added_monitors!(nodes[1], 1);
2264         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2265
2266         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2267         check_added_monitors!(nodes[0], 1);
2268
2269         expect_pending_htlcs_forwardable!(nodes[0]);
2270         expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2271
2272         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2273         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2274 }
2275
2276 #[test]
2277 fn channel_monitor_network_test() {
2278         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2279         // tests that ChannelMonitor is able to recover from various states.
2280         let chanmon_cfgs = create_chanmon_cfgs(5);
2281         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2282         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2283         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2284
2285         // Create some initial channels
2286         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2287         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2288         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2289         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2290
2291         // Make sure all nodes are at the same starting height
2292         connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2293         connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2294         connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2295         connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2296         connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2297
2298         // Rebalance the network a bit by relaying one payment through all the channels...
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         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2303
2304         // Simple case with no pending HTLCs:
2305         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2306         check_added_monitors!(nodes[1], 1);
2307         check_closed_broadcast!(nodes[1], false);
2308         {
2309                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2310                 assert_eq!(node_txn.len(), 1);
2311                 mine_transaction(&nodes[0], &node_txn[0]);
2312                 check_added_monitors!(nodes[0], 1);
2313                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2314         }
2315         check_closed_broadcast!(nodes[0], true);
2316         assert_eq!(nodes[0].node.list_channels().len(), 0);
2317         assert_eq!(nodes[1].node.list_channels().len(), 1);
2318
2319         // One pending HTLC is discarded by the force-close:
2320         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2321
2322         // Simple case of one pending HTLC to HTLC-Timeout
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::TIMEOUT);
2328                 mine_transaction(&nodes[2], &node_txn[0]);
2329                 check_added_monitors!(nodes[2], 1);
2330                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2331         }
2332         check_closed_broadcast!(nodes[2], true);
2333         assert_eq!(nodes[1].node.list_channels().len(), 0);
2334         assert_eq!(nodes[2].node.list_channels().len(), 1);
2335
2336         macro_rules! claim_funds {
2337                 ($node: expr, $prev_node: expr, $preimage: expr) => {
2338                         {
2339                                 assert!($node.node.claim_funds($preimage));
2340                                 check_added_monitors!($node, 1);
2341
2342                                 let events = $node.node.get_and_clear_pending_msg_events();
2343                                 assert_eq!(events.len(), 1);
2344                                 match events[0] {
2345                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2346                                                 assert!(update_add_htlcs.is_empty());
2347                                                 assert!(update_fail_htlcs.is_empty());
2348                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2349                                         },
2350                                         _ => panic!("Unexpected event"),
2351                                 };
2352                         }
2353                 }
2354         }
2355
2356         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2357         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2358         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2359         check_added_monitors!(nodes[2], 1);
2360         check_closed_broadcast!(nodes[2], false);
2361         let node2_commitment_txid;
2362         {
2363                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2364                 node2_commitment_txid = node_txn[0].txid();
2365
2366                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2367                 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2368                 mine_transaction(&nodes[3], &node_txn[0]);
2369                 check_added_monitors!(nodes[3], 1);
2370                 check_preimage_claim(&nodes[3], &node_txn);
2371         }
2372         check_closed_broadcast!(nodes[3], true);
2373         assert_eq!(nodes[2].node.list_channels().len(), 0);
2374         assert_eq!(nodes[3].node.list_channels().len(), 1);
2375
2376         // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2377         // confusing us in the following tests.
2378         let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2379
2380         // One pending HTLC to time out:
2381         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2382         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2383         // buffer space).
2384
2385         let (close_chan_update_1, close_chan_update_2) = {
2386                 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2387                 let events = nodes[3].node.get_and_clear_pending_msg_events();
2388                 assert_eq!(events.len(), 2);
2389                 let close_chan_update_1 = match events[0] {
2390                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2391                                 msg.clone()
2392                         },
2393                         _ => panic!("Unexpected event"),
2394                 };
2395                 match events[1] {
2396                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2397                                 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2398                         },
2399                         _ => panic!("Unexpected event"),
2400                 }
2401                 check_added_monitors!(nodes[3], 1);
2402
2403                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2404                 {
2405                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2406                         node_txn.retain(|tx| {
2407                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2408                                         false
2409                                 } else { true }
2410                         });
2411                 }
2412
2413                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2414
2415                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2416                 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2417
2418                 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2419                 let events = nodes[4].node.get_and_clear_pending_msg_events();
2420                 assert_eq!(events.len(), 2);
2421                 let close_chan_update_2 = match events[0] {
2422                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2423                                 msg.clone()
2424                         },
2425                         _ => panic!("Unexpected event"),
2426                 };
2427                 match events[1] {
2428                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2429                                 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2430                         },
2431                         _ => panic!("Unexpected event"),
2432                 }
2433                 check_added_monitors!(nodes[4], 1);
2434                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2435
2436                 mine_transaction(&nodes[4], &node_txn[0]);
2437                 check_preimage_claim(&nodes[4], &node_txn);
2438                 (close_chan_update_1, close_chan_update_2)
2439         };
2440         nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2441         nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2442         assert_eq!(nodes[3].node.list_channels().len(), 0);
2443         assert_eq!(nodes[4].node.list_channels().len(), 0);
2444
2445         nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2446 }
2447
2448 #[test]
2449 fn test_justice_tx() {
2450         // Test justice txn built on revoked HTLC-Success tx, against both sides
2451         let mut alice_config = UserConfig::default();
2452         alice_config.channel_options.announced_channel = true;
2453         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2454         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2455         let mut bob_config = UserConfig::default();
2456         bob_config.channel_options.announced_channel = true;
2457         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2458         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2459         let user_cfgs = [Some(alice_config), Some(bob_config)];
2460         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2461         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2462         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2463         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2464         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2465         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2466         // Create some new channels:
2467         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2468
2469         // A pending HTLC which will be revoked:
2470         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2471         // Get the will-be-revoked local txn from nodes[0]
2472         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2473         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2474         assert_eq!(revoked_local_txn[0].input.len(), 1);
2475         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2476         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2477         assert_eq!(revoked_local_txn[1].input.len(), 1);
2478         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2479         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2480         // Revoke the old state
2481         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2482
2483         {
2484                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2485                 {
2486                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2487                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2488                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2489
2490                         check_spends!(node_txn[0], revoked_local_txn[0]);
2491                         node_txn.swap_remove(0);
2492                         node_txn.truncate(1);
2493                 }
2494                 check_added_monitors!(nodes[1], 1);
2495                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2496
2497                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2498                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2499                 // Verify broadcast of revoked HTLC-timeout
2500                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2501                 check_added_monitors!(nodes[0], 1);
2502                 // Broadcast revoked HTLC-timeout on node 1
2503                 mine_transaction(&nodes[1], &node_txn[1]);
2504                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2505         }
2506         get_announce_close_broadcast_events(&nodes, 0, 1);
2507
2508         assert_eq!(nodes[0].node.list_channels().len(), 0);
2509         assert_eq!(nodes[1].node.list_channels().len(), 0);
2510
2511         // We test justice_tx build by A on B's revoked HTLC-Success tx
2512         // Create some new channels:
2513         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2514         {
2515                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2516                 node_txn.clear();
2517         }
2518
2519         // A pending HTLC which will be revoked:
2520         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2521         // Get the will-be-revoked local txn from B
2522         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2523         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2524         assert_eq!(revoked_local_txn[0].input.len(), 1);
2525         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2526         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2527         // Revoke the old state
2528         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2529         {
2530                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2531                 {
2532                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2533                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2534                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2535
2536                         check_spends!(node_txn[0], revoked_local_txn[0]);
2537                         node_txn.swap_remove(0);
2538                 }
2539                 check_added_monitors!(nodes[0], 1);
2540                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2541
2542                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2543                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2544                 check_added_monitors!(nodes[1], 1);
2545                 mine_transaction(&nodes[0], &node_txn[1]);
2546                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2547         }
2548         get_announce_close_broadcast_events(&nodes, 0, 1);
2549         assert_eq!(nodes[0].node.list_channels().len(), 0);
2550         assert_eq!(nodes[1].node.list_channels().len(), 0);
2551 }
2552
2553 #[test]
2554 fn revoked_output_claim() {
2555         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2556         // transaction is broadcast by its counterparty
2557         let chanmon_cfgs = create_chanmon_cfgs(2);
2558         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2559         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2560         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2561         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2562         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2563         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2564         assert_eq!(revoked_local_txn.len(), 1);
2565         // Only output is the full channel value back to nodes[0]:
2566         assert_eq!(revoked_local_txn[0].output.len(), 1);
2567         // Send a payment through, updating everyone's latest commitment txn
2568         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2569
2570         // Inform nodes[1] that nodes[0] broadcast a stale tx
2571         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2572         check_added_monitors!(nodes[1], 1);
2573         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2574         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2575
2576         check_spends!(node_txn[0], revoked_local_txn[0]);
2577         check_spends!(node_txn[1], chan_1.3);
2578
2579         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2580         mine_transaction(&nodes[0], &revoked_local_txn[0]);
2581         get_announce_close_broadcast_events(&nodes, 0, 1);
2582         check_added_monitors!(nodes[0], 1)
2583 }
2584
2585 #[test]
2586 fn claim_htlc_outputs_shared_tx() {
2587         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2588         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2589         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2590         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2591         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2592         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2593
2594         // Create some new channel:
2595         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2596
2597         // Rebalance the network to generate htlc in the two directions
2598         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2599         // 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
2600         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2601         let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2602
2603         // Get the will-be-revoked local txn from node[0]
2604         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2605         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2606         assert_eq!(revoked_local_txn[0].input.len(), 1);
2607         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2608         assert_eq!(revoked_local_txn[1].input.len(), 1);
2609         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2610         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2611         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2612
2613         //Revoke the old state
2614         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2615
2616         {
2617                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2618                 check_added_monitors!(nodes[0], 1);
2619                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2620                 check_added_monitors!(nodes[1], 1);
2621                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2622                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2623
2624                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2625                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2626
2627                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2628                 check_spends!(node_txn[0], revoked_local_txn[0]);
2629
2630                 let mut witness_lens = BTreeSet::new();
2631                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2632                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2633                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2634                 assert_eq!(witness_lens.len(), 3);
2635                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2636                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2637                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2638
2639                 // Next nodes[1] broadcasts its current local tx state:
2640                 assert_eq!(node_txn[1].input.len(), 1);
2641                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2642
2643                 assert_eq!(node_txn[2].input.len(), 1);
2644                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2645                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2646                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2647                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2648                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2649         }
2650         get_announce_close_broadcast_events(&nodes, 0, 1);
2651         assert_eq!(nodes[0].node.list_channels().len(), 0);
2652         assert_eq!(nodes[1].node.list_channels().len(), 0);
2653 }
2654
2655 #[test]
2656 fn claim_htlc_outputs_single_tx() {
2657         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2658         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2659         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2660         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2661         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2662         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2663
2664         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2665
2666         // Rebalance the network to generate htlc in the two directions
2667         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2668         // 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
2669         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2670         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2671         let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2672
2673         // Get the will-be-revoked local txn from node[0]
2674         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2675
2676         //Revoke the old state
2677         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2678
2679         {
2680                 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2681                 check_added_monitors!(nodes[0], 1);
2682                 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2683                 check_added_monitors!(nodes[1], 1);
2684                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2685
2686                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2687                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2688
2689                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2690                 assert_eq!(node_txn.len(), 9);
2691                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2692                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2693                 // 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)
2694                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2695
2696                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2697                 assert_eq!(node_txn[0].input.len(), 1);
2698                 check_spends!(node_txn[0], chan_1.3);
2699                 assert_eq!(node_txn[1].input.len(), 1);
2700                 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2701                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2702                 check_spends!(node_txn[1], node_txn[0]);
2703
2704                 // Justice transactions are indices 1-2-4
2705                 assert_eq!(node_txn[2].input.len(), 1);
2706                 assert_eq!(node_txn[3].input.len(), 1);
2707                 assert_eq!(node_txn[4].input.len(), 1);
2708
2709                 check_spends!(node_txn[2], revoked_local_txn[0]);
2710                 check_spends!(node_txn[3], revoked_local_txn[0]);
2711                 check_spends!(node_txn[4], revoked_local_txn[0]);
2712
2713                 let mut witness_lens = BTreeSet::new();
2714                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2715                 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2716                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2717                 assert_eq!(witness_lens.len(), 3);
2718                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2719                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2720                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2721         }
2722         get_announce_close_broadcast_events(&nodes, 0, 1);
2723         assert_eq!(nodes[0].node.list_channels().len(), 0);
2724         assert_eq!(nodes[1].node.list_channels().len(), 0);
2725 }
2726
2727 #[test]
2728 fn test_htlc_on_chain_success() {
2729         // Test that in case of a unilateral close onchain, we detect the state of output and pass
2730         // the preimage backward accordingly. So here we test that ChannelManager is
2731         // broadcasting the right event to other nodes in payment path.
2732         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2733         // A --------------------> B ----------------------> C (preimage)
2734         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2735         // commitment transaction was broadcast.
2736         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2737         // towards B.
2738         // B should be able to claim via preimage if A then broadcasts its local tx.
2739         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2740         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2741         // PaymentSent event).
2742
2743         let chanmon_cfgs = create_chanmon_cfgs(3);
2744         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2745         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2746         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2747
2748         // Create some initial channels
2749         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2750         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2751
2752         // Ensure all nodes are at the same height
2753         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2754         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2755         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2756         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2757
2758         // Rebalance the network a bit by relaying one payment through all the channels...
2759         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2760         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2761
2762         let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2763         let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2764
2765         // Broadcast legit commitment tx from C on B's chain
2766         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2767         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2768         assert_eq!(commitment_tx.len(), 1);
2769         check_spends!(commitment_tx[0], chan_2.3);
2770         nodes[2].node.claim_funds(our_payment_preimage);
2771         nodes[2].node.claim_funds(our_payment_preimage_2);
2772         check_added_monitors!(nodes[2], 2);
2773         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2774         assert!(updates.update_add_htlcs.is_empty());
2775         assert!(updates.update_fail_htlcs.is_empty());
2776         assert!(updates.update_fail_malformed_htlcs.is_empty());
2777         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2778
2779         mine_transaction(&nodes[2], &commitment_tx[0]);
2780         check_closed_broadcast!(nodes[2], true);
2781         check_added_monitors!(nodes[2], 1);
2782         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)
2783         assert_eq!(node_txn.len(), 5);
2784         assert_eq!(node_txn[0], node_txn[3]);
2785         assert_eq!(node_txn[1], node_txn[4]);
2786         assert_eq!(node_txn[2], commitment_tx[0]);
2787         check_spends!(node_txn[0], commitment_tx[0]);
2788         check_spends!(node_txn[1], commitment_tx[0]);
2789         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2790         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2791         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2792         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2793         assert_eq!(node_txn[0].lock_time, 0);
2794         assert_eq!(node_txn[1].lock_time, 0);
2795
2796         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2797         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2798         connect_block(&nodes[1], &Block { header, txdata: node_txn});
2799         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2800         {
2801                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2802                 assert_eq!(added_monitors.len(), 1);
2803                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2804                 added_monitors.clear();
2805         }
2806         let events = nodes[1].node.get_and_clear_pending_msg_events();
2807         {
2808                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2809                 assert_eq!(added_monitors.len(), 2);
2810                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2811                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2812                 added_monitors.clear();
2813         }
2814         assert_eq!(events.len(), 3);
2815         match events[0] {
2816                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2817                 _ => panic!("Unexpected event"),
2818         }
2819         match events[1] {
2820                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2821                 _ => panic!("Unexpected event"),
2822         }
2823
2824         match events[2] {
2825                 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, .. } } => {
2826                         assert!(update_add_htlcs.is_empty());
2827                         assert!(update_fail_htlcs.is_empty());
2828                         assert_eq!(update_fulfill_htlcs.len(), 1);
2829                         assert!(update_fail_malformed_htlcs.is_empty());
2830                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2831                 },
2832                 _ => panic!("Unexpected event"),
2833         };
2834         macro_rules! check_tx_local_broadcast {
2835                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2836                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2837                         assert_eq!(node_txn.len(), 5);
2838                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2839                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2840                         check_spends!(node_txn[3], $commitment_tx);
2841                         check_spends!(node_txn[4], $commitment_tx);
2842                         assert_ne!(node_txn[3].lock_time, 0);
2843                         assert_ne!(node_txn[4].lock_time, 0);
2844                         if $htlc_offered {
2845                                 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2846                                 assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2847                                 assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2848                                 assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2849                         } else {
2850                                 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2851                                 assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2852                                 assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2853                                 assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2854                         }
2855                         check_spends!(node_txn[0], $chan_tx);
2856                         check_spends!(node_txn[1], node_txn[0]);
2857                         check_spends!(node_txn[2], node_txn[0]);
2858                         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2859                         assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2860                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2861                         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2862                         assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2863                         assert_ne!(node_txn[1].lock_time, 0);
2864                         assert_ne!(node_txn[2].lock_time, 0);
2865                         node_txn.clear();
2866                 } }
2867         }
2868         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2869         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2870         // timeout-claim of the output that nodes[2] just claimed via success.
2871         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2872
2873         // Broadcast legit commitment tx from A on B's chain
2874         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2875         let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2876         check_spends!(node_a_commitment_tx[0], chan_1.3);
2877         mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2878         check_closed_broadcast!(nodes[1], true);
2879         check_added_monitors!(nodes[1], 1);
2880         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2881         assert_eq!(node_txn.len(), 6); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 3 (HTLC-Success, 2* RBF bumps of above HTLC txn)
2882         let commitment_spend =
2883                 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2884                         check_spends!(node_txn[1], commitment_tx[0]);
2885                         check_spends!(node_txn[2], commitment_tx[0]);
2886                         assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2887                         &node_txn[0]
2888                 } else {
2889                         check_spends!(node_txn[0], commitment_tx[0]);
2890                         check_spends!(node_txn[1], commitment_tx[0]);
2891                         assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2892                         &node_txn[2]
2893                 };
2894
2895         check_spends!(commitment_spend, node_a_commitment_tx[0]);
2896         assert_eq!(commitment_spend.input.len(), 2);
2897         assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2898         assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2899         assert_eq!(commitment_spend.lock_time, 0);
2900         assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2901         check_spends!(node_txn[3], chan_1.3);
2902         assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2903         check_spends!(node_txn[4], node_txn[3]);
2904         check_spends!(node_txn[5], node_txn[3]);
2905         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2906         // we already checked the same situation with A.
2907
2908         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2909         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2910         connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
2911         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2912         check_closed_broadcast!(nodes[0], true);
2913         check_added_monitors!(nodes[0], 1);
2914         let events = nodes[0].node.get_and_clear_pending_events();
2915         assert_eq!(events.len(), 2);
2916         let mut first_claimed = false;
2917         for event in events {
2918                 match event {
2919                         Event::PaymentSent { payment_preimage } => {
2920                                 if payment_preimage == our_payment_preimage {
2921                                         assert!(!first_claimed);
2922                                         first_claimed = true;
2923                                 } else {
2924                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2925                                 }
2926                         },
2927                         _ => panic!("Unexpected event"),
2928                 }
2929         }
2930         check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0], chan_1.3);
2931 }
2932
2933 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2934         // Test that in case of a unilateral close onchain, we detect the state of output and
2935         // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2936         // broadcasting the right event to other nodes in payment path.
2937         // A ------------------> B ----------------------> C (timeout)
2938         //    B's commitment tx                 C's commitment tx
2939         //            \                                  \
2940         //         B's HTLC timeout tx               B's timeout tx
2941
2942         let chanmon_cfgs = create_chanmon_cfgs(3);
2943         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2944         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2945         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2946         *nodes[0].connect_style.borrow_mut() = connect_style;
2947         *nodes[1].connect_style.borrow_mut() = connect_style;
2948         *nodes[2].connect_style.borrow_mut() = connect_style;
2949
2950         // Create some intial channels
2951         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2952         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2953
2954         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2955         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2956         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2957
2958         let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2959
2960         // Broadcast legit commitment tx from C on B's chain
2961         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2962         check_spends!(commitment_tx[0], chan_2.3);
2963         nodes[2].node.fail_htlc_backwards(&payment_hash);
2964         check_added_monitors!(nodes[2], 0);
2965         expect_pending_htlcs_forwardable!(nodes[2]);
2966         check_added_monitors!(nodes[2], 1);
2967
2968         let events = nodes[2].node.get_and_clear_pending_msg_events();
2969         assert_eq!(events.len(), 1);
2970         match events[0] {
2971                 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, .. } } => {
2972                         assert!(update_add_htlcs.is_empty());
2973                         assert!(!update_fail_htlcs.is_empty());
2974                         assert!(update_fulfill_htlcs.is_empty());
2975                         assert!(update_fail_malformed_htlcs.is_empty());
2976                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2977                 },
2978                 _ => panic!("Unexpected event"),
2979         };
2980         mine_transaction(&nodes[2], &commitment_tx[0]);
2981         check_closed_broadcast!(nodes[2], true);
2982         check_added_monitors!(nodes[2], 1);
2983         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2984         assert_eq!(node_txn.len(), 1);
2985         check_spends!(node_txn[0], chan_2.3);
2986         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2987
2988         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2989         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2990         connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2991         mine_transaction(&nodes[1], &commitment_tx[0]);
2992         let timeout_tx;
2993         {
2994                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2995                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2996                 assert_eq!(node_txn[0], node_txn[3]);
2997                 assert_eq!(node_txn[1], node_txn[4]);
2998
2999                 check_spends!(node_txn[2], commitment_tx[0]);
3000                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3001
3002                 check_spends!(node_txn[0], chan_2.3);
3003                 check_spends!(node_txn[1], node_txn[0]);
3004                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
3005                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3006
3007                 timeout_tx = node_txn[2].clone();
3008                 node_txn.clear();
3009         }
3010
3011         mine_transaction(&nodes[1], &timeout_tx);
3012         check_added_monitors!(nodes[1], 1);
3013         check_closed_broadcast!(nodes[1], true);
3014         {
3015                 // B will rebroadcast a fee-bumped timeout transaction here.
3016                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3017                 assert_eq!(node_txn.len(), 1);
3018                 check_spends!(node_txn[0], commitment_tx[0]);
3019         }
3020
3021         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3022         {
3023                 // B will rebroadcast its own holder commitment transaction here...just because
3024                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3025                 assert_eq!(node_txn.len(), 1);
3026                 check_spends!(node_txn[0], chan_2.3);
3027         }
3028
3029         expect_pending_htlcs_forwardable!(nodes[1]);
3030         check_added_monitors!(nodes[1], 1);
3031         let events = nodes[1].node.get_and_clear_pending_msg_events();
3032         assert_eq!(events.len(), 1);
3033         match events[0] {
3034                 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, .. } } => {
3035                         assert!(update_add_htlcs.is_empty());
3036                         assert!(!update_fail_htlcs.is_empty());
3037                         assert!(update_fulfill_htlcs.is_empty());
3038                         assert!(update_fail_malformed_htlcs.is_empty());
3039                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3040                 },
3041                 _ => panic!("Unexpected event"),
3042         };
3043
3044         // Broadcast legit commitment tx from B on A's chain
3045         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3046         check_spends!(commitment_tx[0], chan_1.3);
3047
3048         mine_transaction(&nodes[0], &commitment_tx[0]);
3049         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
3050
3051         check_closed_broadcast!(nodes[0], true);
3052         check_added_monitors!(nodes[0], 1);
3053         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
3054         assert_eq!(node_txn.len(), 3);
3055         check_spends!(node_txn[0], chan_1.3);
3056         check_spends!(node_txn[1], node_txn[0]);
3057         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
3058         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3059         check_spends!(node_txn[2], commitment_tx[0]);
3060         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3061 }
3062
3063 #[test]
3064 fn test_htlc_on_chain_timeout() {
3065         do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
3066         do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
3067         do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
3068 }
3069
3070 #[test]
3071 fn test_simple_commitment_revoked_fail_backward() {
3072         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3073         // and fail backward accordingly.
3074
3075         let chanmon_cfgs = create_chanmon_cfgs(3);
3076         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3077         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3078         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3079
3080         // Create some initial channels
3081         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3082         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3083
3084         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3085         // Get the will-be-revoked local txn from nodes[2]
3086         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3087         // Revoke the old state
3088         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3089
3090         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3091
3092         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3093         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3094         check_added_monitors!(nodes[1], 1);
3095         check_closed_broadcast!(nodes[1], true);
3096
3097         expect_pending_htlcs_forwardable!(nodes[1]);
3098         check_added_monitors!(nodes[1], 1);
3099         let events = nodes[1].node.get_and_clear_pending_msg_events();
3100         assert_eq!(events.len(), 1);
3101         match events[0] {
3102                 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, .. } } => {
3103                         assert!(update_add_htlcs.is_empty());
3104                         assert_eq!(update_fail_htlcs.len(), 1);
3105                         assert!(update_fulfill_htlcs.is_empty());
3106                         assert!(update_fail_malformed_htlcs.is_empty());
3107                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3108
3109                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3110                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3111
3112                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3113                         assert_eq!(events.len(), 1);
3114                         match events[0] {
3115                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3116                                 _ => panic!("Unexpected event"),
3117                         }
3118                         expect_payment_failed!(nodes[0], payment_hash, false);
3119                 },
3120                 _ => panic!("Unexpected event"),
3121         }
3122 }
3123
3124 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3125         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3126         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3127         // commitment transaction anymore.
3128         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3129         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3130         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3131         // technically disallowed and we should probably handle it reasonably.
3132         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3133         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3134         // transactions:
3135         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3136         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3137         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3138         //   and once they revoke the previous commitment transaction (allowing us to send a new
3139         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3140         let chanmon_cfgs = create_chanmon_cfgs(3);
3141         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3142         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3143         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3144
3145         // Create some initial channels
3146         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3147         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3148
3149         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 });
3150         // Get the will-be-revoked local txn from nodes[2]
3151         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3152         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3153         // Revoke the old state
3154         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3155
3156         let value = if use_dust {
3157                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3158                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3159                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3160         } else { 3000000 };
3161
3162         let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3163         let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3164         let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3165
3166         assert!(nodes[2].node.fail_htlc_backwards(&first_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         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3177         // Drop the last RAA from 3 -> 2
3178
3179         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
3180         expect_pending_htlcs_forwardable!(nodes[2]);
3181         check_added_monitors!(nodes[2], 1);
3182         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3183         assert!(updates.update_add_htlcs.is_empty());
3184         assert!(updates.update_fulfill_htlcs.is_empty());
3185         assert!(updates.update_fail_malformed_htlcs.is_empty());
3186         assert_eq!(updates.update_fail_htlcs.len(), 1);
3187         assert!(updates.update_fee.is_none());
3188         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3189         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3190         check_added_monitors!(nodes[1], 1);
3191         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3192         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3193         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3194         check_added_monitors!(nodes[2], 1);
3195
3196         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
3197         expect_pending_htlcs_forwardable!(nodes[2]);
3198         check_added_monitors!(nodes[2], 1);
3199         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3200         assert!(updates.update_add_htlcs.is_empty());
3201         assert!(updates.update_fulfill_htlcs.is_empty());
3202         assert!(updates.update_fail_malformed_htlcs.is_empty());
3203         assert_eq!(updates.update_fail_htlcs.len(), 1);
3204         assert!(updates.update_fee.is_none());
3205         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3206         // At this point first_payment_hash has dropped out of the latest two commitment
3207         // transactions that nodes[1] is tracking...
3208         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3209         check_added_monitors!(nodes[1], 1);
3210         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3211         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3212         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3213         check_added_monitors!(nodes[2], 1);
3214
3215         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3216         // on nodes[2]'s RAA.
3217         let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3218         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3219         let logger = test_utils::TestLogger::new();
3220         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();
3221         nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
3222         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3223         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3224         check_added_monitors!(nodes[1], 0);
3225
3226         if deliver_bs_raa {
3227                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3228                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3229                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3230                 check_added_monitors!(nodes[1], 1);
3231                 let events = nodes[1].node.get_and_clear_pending_events();
3232                 assert_eq!(events.len(), 1);
3233                 match events[0] {
3234                         Event::PendingHTLCsForwardable { .. } => { },
3235                         _ => panic!("Unexpected event"),
3236                 };
3237                 // Deliberately don't process the pending fail-back so they all fail back at once after
3238                 // block connection just like the !deliver_bs_raa case
3239         }
3240
3241         let mut failed_htlcs = HashSet::new();
3242         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3243
3244         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3245         check_added_monitors!(nodes[1], 1);
3246         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3247
3248         let events = nodes[1].node.get_and_clear_pending_events();
3249         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3250         match events[0] {
3251                 Event::PaymentFailed { ref payment_hash, .. } => {
3252                         assert_eq!(*payment_hash, fourth_payment_hash);
3253                 },
3254                 _ => panic!("Unexpected event"),
3255         }
3256         if !deliver_bs_raa {
3257                 match events[1] {
3258                         Event::PendingHTLCsForwardable { .. } => { },
3259                         _ => panic!("Unexpected event"),
3260                 };
3261         }
3262         nodes[1].node.process_pending_htlc_forwards();
3263         check_added_monitors!(nodes[1], 1);
3264
3265         let events = nodes[1].node.get_and_clear_pending_msg_events();
3266         assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3267         match events[if deliver_bs_raa { 1 } else { 0 }] {
3268                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3269                 _ => panic!("Unexpected event"),
3270         }
3271         match events[if deliver_bs_raa { 2 } else { 1 }] {
3272                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3273                         assert_eq!(channel_id, chan_2.2);
3274                         assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3275                 },
3276                 _ => panic!("Unexpected event"),
3277         }
3278         if deliver_bs_raa {
3279                 match events[0] {
3280                         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, .. } } => {
3281                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3282                                 assert_eq!(update_add_htlcs.len(), 1);
3283                                 assert!(update_fulfill_htlcs.is_empty());
3284                                 assert!(update_fail_htlcs.is_empty());
3285                                 assert!(update_fail_malformed_htlcs.is_empty());
3286                         },
3287                         _ => panic!("Unexpected event"),
3288                 }
3289         }
3290         match events[if deliver_bs_raa { 3 } else { 2 }] {
3291                 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, .. } } => {
3292                         assert!(update_add_htlcs.is_empty());
3293                         assert_eq!(update_fail_htlcs.len(), 3);
3294                         assert!(update_fulfill_htlcs.is_empty());
3295                         assert!(update_fail_malformed_htlcs.is_empty());
3296                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3297
3298                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3299                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3300                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3301
3302                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3303
3304                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3305                         // If we delivered B's RAA we got an unknown preimage error, not something
3306                         // that we should update our routing table for.
3307                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3308                         for event in events {
3309                                 match event {
3310                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3311                                         _ => panic!("Unexpected event"),
3312                                 }
3313                         }
3314                         let events = nodes[0].node.get_and_clear_pending_events();
3315                         assert_eq!(events.len(), 3);
3316                         match events[0] {
3317                                 Event::PaymentFailed { ref payment_hash, .. } => {
3318                                         assert!(failed_htlcs.insert(payment_hash.0));
3319                                 },
3320                                 _ => panic!("Unexpected event"),
3321                         }
3322                         match events[1] {
3323                                 Event::PaymentFailed { ref payment_hash, .. } => {
3324                                         assert!(failed_htlcs.insert(payment_hash.0));
3325                                 },
3326                                 _ => panic!("Unexpected event"),
3327                         }
3328                         match events[2] {
3329                                 Event::PaymentFailed { ref payment_hash, .. } => {
3330                                         assert!(failed_htlcs.insert(payment_hash.0));
3331                                 },
3332                                 _ => panic!("Unexpected event"),
3333                         }
3334                 },
3335                 _ => panic!("Unexpected event"),
3336         }
3337
3338         assert!(failed_htlcs.contains(&first_payment_hash.0));
3339         assert!(failed_htlcs.contains(&second_payment_hash.0));
3340         assert!(failed_htlcs.contains(&third_payment_hash.0));
3341 }
3342
3343 #[test]
3344 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3345         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3346         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3347         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3348         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3349 }
3350
3351 #[test]
3352 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3353         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3354         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3355         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3356         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3357 }
3358
3359 #[test]
3360 fn fail_backward_pending_htlc_upon_channel_failure() {
3361         let chanmon_cfgs = create_chanmon_cfgs(2);
3362         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3363         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3364         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3365         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3366         let logger = test_utils::TestLogger::new();
3367
3368         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3369         {
3370                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3371                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3372                 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();
3373                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3374                 check_added_monitors!(nodes[0], 1);
3375
3376                 let payment_event = {
3377                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3378                         assert_eq!(events.len(), 1);
3379                         SendEvent::from_event(events.remove(0))
3380                 };
3381                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3382                 assert_eq!(payment_event.msgs.len(), 1);
3383         }
3384
3385         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3386         let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3387         {
3388                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3389                 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();
3390                 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3391                 check_added_monitors!(nodes[0], 0);
3392
3393                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3394         }
3395
3396         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3397         {
3398                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3399
3400                 let secp_ctx = Secp256k1::new();
3401                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3402                 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3403                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3404                 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();
3405                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height).unwrap();
3406                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3407                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3408
3409                 // Send a 0-msat update_add_htlc to fail the channel.
3410                 let update_add_htlc = msgs::UpdateAddHTLC {
3411                         channel_id: chan.2,
3412                         htlc_id: 0,
3413                         amount_msat: 0,
3414                         payment_hash,
3415                         cltv_expiry,
3416                         onion_routing_packet,
3417                 };
3418                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3419         }
3420
3421         // Check that Alice fails backward the pending HTLC from the second payment.
3422         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3423         check_closed_broadcast!(nodes[0], true);
3424         check_added_monitors!(nodes[0], 1);
3425 }
3426
3427 #[test]
3428 fn test_htlc_ignore_latest_remote_commitment() {
3429         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3430         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3431         let chanmon_cfgs = create_chanmon_cfgs(2);
3432         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3433         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3434         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3435         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3436
3437         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3438         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3439         check_closed_broadcast!(nodes[0], true);
3440         check_added_monitors!(nodes[0], 1);
3441
3442         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3443         assert_eq!(node_txn.len(), 2);
3444
3445         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3446         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3447         check_closed_broadcast!(nodes[1], true);
3448         check_added_monitors!(nodes[1], 1);
3449
3450         // Duplicate the connect_block call since this may happen due to other listeners
3451         // registering new transactions
3452         header.prev_blockhash = header.block_hash();
3453         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3454 }
3455
3456 #[test]
3457 fn test_force_close_fail_back() {
3458         // Check which HTLCs are failed-backwards on channel force-closure
3459         let chanmon_cfgs = create_chanmon_cfgs(3);
3460         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3461         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3462         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3463         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3464         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3465         let logger = test_utils::TestLogger::new();
3466
3467         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3468
3469         let mut payment_event = {
3470                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3471                 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();
3472                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3473                 check_added_monitors!(nodes[0], 1);
3474
3475                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3476                 assert_eq!(events.len(), 1);
3477                 SendEvent::from_event(events.remove(0))
3478         };
3479
3480         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3481         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3482
3483         expect_pending_htlcs_forwardable!(nodes[1]);
3484
3485         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3486         assert_eq!(events_2.len(), 1);
3487         payment_event = SendEvent::from_event(events_2.remove(0));
3488         assert_eq!(payment_event.msgs.len(), 1);
3489
3490         check_added_monitors!(nodes[1], 1);
3491         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3492         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3493         check_added_monitors!(nodes[2], 1);
3494         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3495
3496         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3497         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3498         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3499
3500         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3501         check_closed_broadcast!(nodes[2], true);
3502         check_added_monitors!(nodes[2], 1);
3503         let tx = {
3504                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3505                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3506                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3507                 // back to nodes[1] upon timeout otherwise.
3508                 assert_eq!(node_txn.len(), 1);
3509                 node_txn.remove(0)
3510         };
3511
3512         mine_transaction(&nodes[1], &tx);
3513
3514         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3515         check_closed_broadcast!(nodes[1], true);
3516         check_added_monitors!(nodes[1], 1);
3517
3518         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3519         {
3520                 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3521                 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3522                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3523         }
3524         mine_transaction(&nodes[2], &tx);
3525         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3526         assert_eq!(node_txn.len(), 1);
3527         assert_eq!(node_txn[0].input.len(), 1);
3528         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3529         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3530         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3531
3532         check_spends!(node_txn[0], tx);
3533 }
3534
3535 #[test]
3536 fn test_dup_events_on_peer_disconnect() {
3537         // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3538         // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3539         // as we used to generate the event immediately upon receipt of the payment preimage in the
3540         // update_fulfill_htlc message.
3541
3542         let chanmon_cfgs = create_chanmon_cfgs(2);
3543         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3544         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3545         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3546         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3547
3548         let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3549
3550         assert!(nodes[1].node.claim_funds(payment_preimage));
3551         check_added_monitors!(nodes[1], 1);
3552         let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3553         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3554         expect_payment_sent!(nodes[0], payment_preimage);
3555
3556         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3557         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3558
3559         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3560         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3561 }
3562
3563 #[test]
3564 fn test_simple_peer_disconnect() {
3565         // Test that we can reconnect when there are no lost messages
3566         let chanmon_cfgs = create_chanmon_cfgs(3);
3567         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3568         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3569         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3570         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3571         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3572
3573         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3574         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3575         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3576
3577         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3578         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3579         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3580         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3581
3582         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3583         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3584         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3585
3586         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3587         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3588         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3589         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3590
3591         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3592         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3593
3594         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3595         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3596
3597         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3598         {
3599                 let events = nodes[0].node.get_and_clear_pending_events();
3600                 assert_eq!(events.len(), 2);
3601                 match events[0] {
3602                         Event::PaymentSent { payment_preimage } => {
3603                                 assert_eq!(payment_preimage, payment_preimage_3);
3604                         },
3605                         _ => panic!("Unexpected event"),
3606                 }
3607                 match events[1] {
3608                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3609                                 assert_eq!(payment_hash, payment_hash_5);
3610                                 assert!(rejected_by_dest);
3611                         },
3612                         _ => panic!("Unexpected event"),
3613                 }
3614         }
3615
3616         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3617         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3618 }
3619
3620 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3621         // Test that we can reconnect when in-flight HTLC updates get dropped
3622         let chanmon_cfgs = create_chanmon_cfgs(2);
3623         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3624         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3625         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3626         if messages_delivered == 0 {
3627                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3628                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3629         } else {
3630                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3631         }
3632
3633         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3634
3635         let logger = test_utils::TestLogger::new();
3636         let payment_event = {
3637                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3638                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3639                         &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3640                         &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3641                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3642                 check_added_monitors!(nodes[0], 1);
3643
3644                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3645                 assert_eq!(events.len(), 1);
3646                 SendEvent::from_event(events.remove(0))
3647         };
3648         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3649
3650         if messages_delivered < 2 {
3651                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3652         } else {
3653                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3654                 if messages_delivered >= 3 {
3655                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3656                         check_added_monitors!(nodes[1], 1);
3657                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3658
3659                         if messages_delivered >= 4 {
3660                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3661                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3662                                 check_added_monitors!(nodes[0], 1);
3663
3664                                 if messages_delivered >= 5 {
3665                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3666                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3667                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3668                                         check_added_monitors!(nodes[0], 1);
3669
3670                                         if messages_delivered >= 6 {
3671                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3672                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3673                                                 check_added_monitors!(nodes[1], 1);
3674                                         }
3675                                 }
3676                         }
3677                 }
3678         }
3679
3680         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3681         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3682         if messages_delivered < 3 {
3683                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3684                 // received on either side, both sides will need to resend them.
3685                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3686         } else if messages_delivered == 3 {
3687                 // nodes[0] still wants its RAA + commitment_signed
3688                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3689         } else if messages_delivered == 4 {
3690                 // nodes[0] still wants its commitment_signed
3691                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3692         } else if messages_delivered == 5 {
3693                 // nodes[1] still wants its final RAA
3694                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3695         } else if messages_delivered == 6 {
3696                 // Everything was delivered...
3697                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3698         }
3699
3700         let events_1 = nodes[1].node.get_and_clear_pending_events();
3701         assert_eq!(events_1.len(), 1);
3702         match events_1[0] {
3703                 Event::PendingHTLCsForwardable { .. } => { },
3704                 _ => panic!("Unexpected event"),
3705         };
3706
3707         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3708         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3709         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3710
3711         nodes[1].node.process_pending_htlc_forwards();
3712
3713         let events_2 = nodes[1].node.get_and_clear_pending_events();
3714         assert_eq!(events_2.len(), 1);
3715         match events_2[0] {
3716                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
3717                         assert_eq!(payment_hash_1, *payment_hash);
3718                         assert!(payment_preimage.is_none());
3719                         assert_eq!(payment_secret_1, *payment_secret);
3720                         assert_eq!(amt, 1000000);
3721                 },
3722                 _ => panic!("Unexpected event"),
3723         }
3724
3725         nodes[1].node.claim_funds(payment_preimage_1);
3726         check_added_monitors!(nodes[1], 1);
3727
3728         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3729         assert_eq!(events_3.len(), 1);
3730         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3731                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3732                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3733                         assert!(updates.update_add_htlcs.is_empty());
3734                         assert!(updates.update_fail_htlcs.is_empty());
3735                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3736                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3737                         assert!(updates.update_fee.is_none());
3738                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3739                 },
3740                 _ => panic!("Unexpected event"),
3741         };
3742
3743         if messages_delivered >= 1 {
3744                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3745
3746                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3747                 assert_eq!(events_4.len(), 1);
3748                 match events_4[0] {
3749                         Event::PaymentSent { ref payment_preimage } => {
3750                                 assert_eq!(payment_preimage_1, *payment_preimage);
3751                         },
3752                         _ => panic!("Unexpected event"),
3753                 }
3754
3755                 if messages_delivered >= 2 {
3756                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3757                         check_added_monitors!(nodes[0], 1);
3758                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3759
3760                         if messages_delivered >= 3 {
3761                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3762                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3763                                 check_added_monitors!(nodes[1], 1);
3764
3765                                 if messages_delivered >= 4 {
3766                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3767                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3768                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3769                                         check_added_monitors!(nodes[1], 1);
3770
3771                                         if messages_delivered >= 5 {
3772                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3773                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3774                                                 check_added_monitors!(nodes[0], 1);
3775                                         }
3776                                 }
3777                         }
3778                 }
3779         }
3780
3781         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3782         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3783         if messages_delivered < 2 {
3784                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3785                 if messages_delivered < 1 {
3786                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3787                         assert_eq!(events_4.len(), 1);
3788                         match events_4[0] {
3789                                 Event::PaymentSent { ref payment_preimage } => {
3790                                         assert_eq!(payment_preimage_1, *payment_preimage);
3791                                 },
3792                                 _ => panic!("Unexpected event"),
3793                         }
3794                 } else {
3795                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3796                 }
3797         } else if messages_delivered == 2 {
3798                 // nodes[0] still wants its RAA + commitment_signed
3799                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3800         } else if messages_delivered == 3 {
3801                 // nodes[0] still wants its commitment_signed
3802                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3803         } else if messages_delivered == 4 {
3804                 // nodes[1] still wants its final RAA
3805                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3806         } else if messages_delivered == 5 {
3807                 // Everything was delivered...
3808                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3809         }
3810
3811         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3812         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3813         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3814
3815         // Channel should still work fine...
3816         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3817         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3818                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3819                 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3820         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3821         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3822 }
3823
3824 #[test]
3825 fn test_drop_messages_peer_disconnect_a() {
3826         do_test_drop_messages_peer_disconnect(0);
3827         do_test_drop_messages_peer_disconnect(1);
3828         do_test_drop_messages_peer_disconnect(2);
3829         do_test_drop_messages_peer_disconnect(3);
3830 }
3831
3832 #[test]
3833 fn test_drop_messages_peer_disconnect_b() {
3834         do_test_drop_messages_peer_disconnect(4);
3835         do_test_drop_messages_peer_disconnect(5);
3836         do_test_drop_messages_peer_disconnect(6);
3837 }
3838
3839 #[test]
3840 fn test_funding_peer_disconnect() {
3841         // Test that we can lock in our funding tx while disconnected
3842         let chanmon_cfgs = create_chanmon_cfgs(2);
3843         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3844         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3845         let persister: test_utils::TestPersister;
3846         let new_chain_monitor: test_utils::TestChainMonitor;
3847         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3848         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3849         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3850
3851         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3852         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3853
3854         confirm_transaction(&nodes[0], &tx);
3855         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3856         assert_eq!(events_1.len(), 1);
3857         match events_1[0] {
3858                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3859                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3860                 },
3861                 _ => panic!("Unexpected event"),
3862         }
3863
3864         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3865
3866         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3867         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3868
3869         confirm_transaction(&nodes[1], &tx);
3870         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3871         assert_eq!(events_2.len(), 2);
3872         let funding_locked = match events_2[0] {
3873                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3874                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3875                         msg.clone()
3876                 },
3877                 _ => panic!("Unexpected event"),
3878         };
3879         let bs_announcement_sigs = match events_2[1] {
3880                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3881                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3882                         msg.clone()
3883                 },
3884                 _ => panic!("Unexpected event"),
3885         };
3886
3887         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3888
3889         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3890         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3891         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3892         assert_eq!(events_3.len(), 2);
3893         let as_announcement_sigs = match events_3[0] {
3894                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3895                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3896                         msg.clone()
3897                 },
3898                 _ => panic!("Unexpected event"),
3899         };
3900         let (as_announcement, as_update) = match events_3[1] {
3901                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3902                         (msg.clone(), update_msg.clone())
3903                 },
3904                 _ => panic!("Unexpected event"),
3905         };
3906
3907         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3908         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3909         assert_eq!(events_4.len(), 1);
3910         let (_, bs_update) = match events_4[0] {
3911                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3912                         (msg.clone(), update_msg.clone())
3913                 },
3914                 _ => panic!("Unexpected event"),
3915         };
3916
3917         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3918         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3919         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3920
3921         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3922         let logger = test_utils::TestLogger::new();
3923         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();
3924         let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3925         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3926
3927         // Check that after deserialization and reconnection we can still generate an identical
3928         // channel_announcement from the cached signatures.
3929         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3930
3931         let nodes_0_serialized = nodes[0].node.encode();
3932         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3933         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3934
3935         persister = test_utils::TestPersister::new();
3936         let keys_manager = &chanmon_cfgs[0].keys_manager;
3937         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);
3938         nodes[0].chain_monitor = &new_chain_monitor;
3939         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3940         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3941                 &mut chan_0_monitor_read, keys_manager).unwrap();
3942         assert!(chan_0_monitor_read.is_empty());
3943
3944         let mut nodes_0_read = &nodes_0_serialized[..];
3945         let (_, nodes_0_deserialized_tmp) = {
3946                 let mut channel_monitors = HashMap::new();
3947                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3948                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3949                         default_config: UserConfig::default(),
3950                         keys_manager,
3951                         fee_estimator: node_cfgs[0].fee_estimator,
3952                         chain_monitor: nodes[0].chain_monitor,
3953                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3954                         logger: nodes[0].logger,
3955                         channel_monitors,
3956                 }).unwrap()
3957         };
3958         nodes_0_deserialized = nodes_0_deserialized_tmp;
3959         assert!(nodes_0_read.is_empty());
3960
3961         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
3962         nodes[0].node = &nodes_0_deserialized;
3963         check_added_monitors!(nodes[0], 1);
3964
3965         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3966
3967         // as_announcement should be re-generated exactly by broadcast_node_announcement.
3968         nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
3969         let msgs = nodes[0].node.get_and_clear_pending_msg_events();
3970         let mut found_announcement = false;
3971         for event in msgs.iter() {
3972                 match event {
3973                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
3974                                 if *msg == as_announcement { found_announcement = true; }
3975                         },
3976                         MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
3977                         _ => panic!("Unexpected event"),
3978                 }
3979         }
3980         assert!(found_announcement);
3981 }
3982
3983 #[test]
3984 fn test_drop_messages_peer_disconnect_dual_htlc() {
3985         // Test that we can handle reconnecting when both sides of a channel have pending
3986         // commitment_updates when we disconnect.
3987         let chanmon_cfgs = create_chanmon_cfgs(2);
3988         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3989         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3990         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3991         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3992         let logger = test_utils::TestLogger::new();
3993
3994         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3995
3996         // Now try to send a second payment which will fail to send
3997         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
3998         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3999         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();
4000         nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
4001         check_added_monitors!(nodes[0], 1);
4002
4003         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
4004         assert_eq!(events_1.len(), 1);
4005         match events_1[0] {
4006                 MessageSendEvent::UpdateHTLCs { .. } => {},
4007                 _ => panic!("Unexpected event"),
4008         }
4009
4010         assert!(nodes[1].node.claim_funds(payment_preimage_1));
4011         check_added_monitors!(nodes[1], 1);
4012
4013         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
4014         assert_eq!(events_2.len(), 1);
4015         match events_2[0] {
4016                 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 } } => {
4017                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4018                         assert!(update_add_htlcs.is_empty());
4019                         assert_eq!(update_fulfill_htlcs.len(), 1);
4020                         assert!(update_fail_htlcs.is_empty());
4021                         assert!(update_fail_malformed_htlcs.is_empty());
4022                         assert!(update_fee.is_none());
4023
4024                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
4025                         let events_3 = nodes[0].node.get_and_clear_pending_events();
4026                         assert_eq!(events_3.len(), 1);
4027                         match events_3[0] {
4028                                 Event::PaymentSent { ref payment_preimage } => {
4029                                         assert_eq!(*payment_preimage, payment_preimage_1);
4030                                 },
4031                                 _ => panic!("Unexpected event"),
4032                         }
4033
4034                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
4035                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4036                         // No commitment_signed so get_event_msg's assert(len == 1) passes
4037                         check_added_monitors!(nodes[0], 1);
4038                 },
4039                 _ => panic!("Unexpected event"),
4040         }
4041
4042         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4043         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4044
4045         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4046         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4047         assert_eq!(reestablish_1.len(), 1);
4048         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4049         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4050         assert_eq!(reestablish_2.len(), 1);
4051
4052         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4053         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4054         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4055         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4056
4057         assert!(as_resp.0.is_none());
4058         assert!(bs_resp.0.is_none());
4059
4060         assert!(bs_resp.1.is_none());
4061         assert!(bs_resp.2.is_none());
4062
4063         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4064
4065         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
4066         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
4067         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4068         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4069         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
4070         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
4071         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
4072         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4073         // No commitment_signed so get_event_msg's assert(len == 1) passes
4074         check_added_monitors!(nodes[1], 1);
4075
4076         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
4077         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4078         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4079         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4080         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4081         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4082         assert!(bs_second_commitment_signed.update_fee.is_none());
4083         check_added_monitors!(nodes[1], 1);
4084
4085         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4086         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4087         assert!(as_commitment_signed.update_add_htlcs.is_empty());
4088         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4089         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4090         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4091         assert!(as_commitment_signed.update_fee.is_none());
4092         check_added_monitors!(nodes[0], 1);
4093
4094         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4095         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4096         // No commitment_signed so get_event_msg's assert(len == 1) passes
4097         check_added_monitors!(nodes[0], 1);
4098
4099         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4100         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4101         // No commitment_signed so get_event_msg's assert(len == 1) passes
4102         check_added_monitors!(nodes[1], 1);
4103
4104         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4105         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4106         check_added_monitors!(nodes[1], 1);
4107
4108         expect_pending_htlcs_forwardable!(nodes[1]);
4109
4110         let events_5 = nodes[1].node.get_and_clear_pending_events();
4111         assert_eq!(events_5.len(), 1);
4112         match events_5[0] {
4113                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt: _, user_payment_id: _ } => {
4114                         assert_eq!(payment_hash_2, *payment_hash);
4115                         assert!(payment_preimage.is_none());
4116                         assert_eq!(payment_secret_2, *payment_secret);
4117                 },
4118                 _ => panic!("Unexpected event"),
4119         }
4120
4121         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4122         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4123         check_added_monitors!(nodes[0], 1);
4124
4125         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4126 }
4127
4128 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4129         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4130         // to avoid our counterparty failing the channel.
4131         let chanmon_cfgs = create_chanmon_cfgs(2);
4132         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4133         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4134         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4135
4136         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4137         let logger = test_utils::TestLogger::new();
4138
4139         let our_payment_hash = if send_partial_mpp {
4140                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4141                 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();
4142                 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
4143                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4144                 // indicates there are more HTLCs coming.
4145                 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.
4146                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height).unwrap();
4147                 check_added_monitors!(nodes[0], 1);
4148                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4149                 assert_eq!(events.len(), 1);
4150                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4151                 // hop should *not* yet generate any PaymentReceived event(s).
4152                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, payment_secret, events.drain(..).next().unwrap(), false);
4153                 our_payment_hash
4154         } else {
4155                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4156         };
4157
4158         let mut block = Block {
4159                 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4160                 txdata: vec![],
4161         };
4162         connect_block(&nodes[0], &block);
4163         connect_block(&nodes[1], &block);
4164         let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
4165         for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
4166                 block.header.prev_blockhash = block.block_hash();
4167                 connect_block(&nodes[0], &block);
4168                 connect_block(&nodes[1], &block);
4169         }
4170
4171         expect_pending_htlcs_forwardable!(nodes[1]);
4172
4173         check_added_monitors!(nodes[1], 1);
4174         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4175         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4176         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4177         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4178         assert!(htlc_timeout_updates.update_fee.is_none());
4179
4180         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4181         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4182         // 100_000 msat as u64, followed by the height at which we failed back above
4183         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4184         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4185         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4186 }
4187
4188 #[test]
4189 fn test_htlc_timeout() {
4190         do_test_htlc_timeout(true);
4191         do_test_htlc_timeout(false);
4192 }
4193
4194 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4195         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4196         let chanmon_cfgs = create_chanmon_cfgs(3);
4197         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4198         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4199         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4200         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4201         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4202
4203         // Make sure all nodes are at the same starting height
4204         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4205         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4206         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4207
4208         let logger = test_utils::TestLogger::new();
4209
4210         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4211         let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4212         {
4213                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4214                 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();
4215                 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4216         }
4217         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4218         check_added_monitors!(nodes[1], 1);
4219
4220         // Now attempt to route a second payment, which should be placed in the holding cell
4221         let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4222         if forwarded_htlc {
4223                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4224                 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();
4225                 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4226                 check_added_monitors!(nodes[0], 1);
4227                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4228                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4229                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4230                 expect_pending_htlcs_forwardable!(nodes[1]);
4231                 check_added_monitors!(nodes[1], 0);
4232         } else {
4233                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4234                 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();
4235                 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4236                 check_added_monitors!(nodes[1], 0);
4237         }
4238
4239         connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4240         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4241         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4242         connect_blocks(&nodes[1], 1);
4243
4244         if forwarded_htlc {
4245                 expect_pending_htlcs_forwardable!(nodes[1]);
4246                 check_added_monitors!(nodes[1], 1);
4247                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4248                 assert_eq!(fail_commit.len(), 1);
4249                 match fail_commit[0] {
4250                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4251                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4252                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4253                         },
4254                         _ => unreachable!(),
4255                 }
4256                 expect_payment_failed!(nodes[0], second_payment_hash, false);
4257                 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4258                         match update {
4259                                 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4260                                 _ => panic!("Unexpected event"),
4261                         }
4262                 } else {
4263                         panic!("Unexpected event");
4264                 }
4265         } else {
4266                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4267         }
4268 }
4269
4270 #[test]
4271 fn test_holding_cell_htlc_add_timeouts() {
4272         do_test_holding_cell_htlc_add_timeouts(false);
4273         do_test_holding_cell_htlc_add_timeouts(true);
4274 }
4275
4276 #[test]
4277 fn test_invalid_channel_announcement() {
4278         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4279         let secp_ctx = Secp256k1::new();
4280         let chanmon_cfgs = create_chanmon_cfgs(2);
4281         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4282         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4283         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4284
4285         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4286
4287         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4288         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4289         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4290         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4291
4292         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 } );
4293
4294         let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4295         let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4296
4297         let as_network_key = nodes[0].node.get_our_node_id();
4298         let bs_network_key = nodes[1].node.get_our_node_id();
4299
4300         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4301
4302         let mut chan_announcement;
4303
4304         macro_rules! dummy_unsigned_msg {
4305                 () => {
4306                         msgs::UnsignedChannelAnnouncement {
4307                                 features: ChannelFeatures::known(),
4308                                 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4309                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4310                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4311                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4312                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4313                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4314                                 excess_data: Vec::new(),
4315                         };
4316                 }
4317         }
4318
4319         macro_rules! sign_msg {
4320                 ($unsigned_msg: expr) => {
4321                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4322                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4323                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4324                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4325                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4326                         chan_announcement = msgs::ChannelAnnouncement {
4327                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4328                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4329                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4330                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4331                                 contents: $unsigned_msg
4332                         }
4333                 }
4334         }
4335
4336         let unsigned_msg = dummy_unsigned_msg!();
4337         sign_msg!(unsigned_msg);
4338         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4339         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 } );
4340
4341         // Configured with Network::Testnet
4342         let mut unsigned_msg = dummy_unsigned_msg!();
4343         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4344         sign_msg!(unsigned_msg);
4345         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4346
4347         let mut unsigned_msg = dummy_unsigned_msg!();
4348         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4349         sign_msg!(unsigned_msg);
4350         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4351 }
4352
4353 #[test]
4354 fn test_no_txn_manager_serialize_deserialize() {
4355         let chanmon_cfgs = create_chanmon_cfgs(2);
4356         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4357         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4358         let logger: test_utils::TestLogger;
4359         let fee_estimator: test_utils::TestFeeEstimator;
4360         let persister: test_utils::TestPersister;
4361         let new_chain_monitor: test_utils::TestChainMonitor;
4362         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4363         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4364
4365         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4366
4367         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4368
4369         let nodes_0_serialized = nodes[0].node.encode();
4370         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4371         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4372
4373         logger = test_utils::TestLogger::new();
4374         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4375         persister = test_utils::TestPersister::new();
4376         let keys_manager = &chanmon_cfgs[0].keys_manager;
4377         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4378         nodes[0].chain_monitor = &new_chain_monitor;
4379         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4380         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4381                 &mut chan_0_monitor_read, keys_manager).unwrap();
4382         assert!(chan_0_monitor_read.is_empty());
4383
4384         let mut nodes_0_read = &nodes_0_serialized[..];
4385         let config = UserConfig::default();
4386         let (_, nodes_0_deserialized_tmp) = {
4387                 let mut channel_monitors = HashMap::new();
4388                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4389                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4390                         default_config: config,
4391                         keys_manager,
4392                         fee_estimator: &fee_estimator,
4393                         chain_monitor: nodes[0].chain_monitor,
4394                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4395                         logger: &logger,
4396                         channel_monitors,
4397                 }).unwrap()
4398         };
4399         nodes_0_deserialized = nodes_0_deserialized_tmp;
4400         assert!(nodes_0_read.is_empty());
4401
4402         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4403         nodes[0].node = &nodes_0_deserialized;
4404         assert_eq!(nodes[0].node.list_channels().len(), 1);
4405         check_added_monitors!(nodes[0], 1);
4406
4407         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4408         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4409         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4410         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4411
4412         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4413         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4414         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4415         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4416
4417         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4418         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4419         for node in nodes.iter() {
4420                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4421                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4422                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4423         }
4424
4425         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4426 }
4427
4428 #[test]
4429 fn test_dup_htlc_onchain_fails_on_reload() {
4430         // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4431         // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4432         // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4433         // the ChannelMonitor tells it to.
4434         //
4435         // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4436         // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4437         // PaymentFailed event appearing). However, because we may not serialize the relevant
4438         // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4439         // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4440         // and de-duplicates ChannelMonitor events.
4441         //
4442         // This tests that explicit tracking behavior.
4443         let chanmon_cfgs = create_chanmon_cfgs(2);
4444         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4445         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4446         let persister: test_utils::TestPersister;
4447         let new_chain_monitor: test_utils::TestChainMonitor;
4448         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4449         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4450
4451         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4452
4453         // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4454         // nodes[0].
4455         let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4456         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4457         check_closed_broadcast!(nodes[0], true);
4458         check_added_monitors!(nodes[0], 1);
4459
4460         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4461         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4462
4463         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4464         assert_eq!(node_txn.len(), 2);
4465
4466         assert!(nodes[1].node.claim_funds(payment_preimage));
4467         check_added_monitors!(nodes[1], 1);
4468
4469         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4470         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
4471         check_closed_broadcast!(nodes[1], true);
4472         check_added_monitors!(nodes[1], 1);
4473         let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4474
4475         connect_block(&nodes[0], &Block { header, txdata: node_txn});
4476
4477         // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4478         // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4479         // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4480         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4481         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4482
4483         header.prev_blockhash = header.block_hash();
4484         let claim_block = Block { header, txdata: claim_txn};
4485         connect_block(&nodes[0], &claim_block);
4486         expect_payment_sent!(nodes[0], payment_preimage);
4487
4488         // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4489         // connected a highly-relevant block, it likely gets serialized out now.
4490         let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4491         nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4492
4493         // Now reload nodes[0]...
4494         persister = test_utils::TestPersister::new();
4495         let keys_manager = &chanmon_cfgs[0].keys_manager;
4496         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);
4497         nodes[0].chain_monitor = &new_chain_monitor;
4498         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4499         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4500                 &mut chan_0_monitor_read, keys_manager).unwrap();
4501         assert!(chan_0_monitor_read.is_empty());
4502
4503         let (_, nodes_0_deserialized_tmp) = {
4504                 let mut channel_monitors = HashMap::new();
4505                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4506                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4507                         ::read(&mut std::io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4508                                 default_config: Default::default(),
4509                                 keys_manager,
4510                                 fee_estimator: node_cfgs[0].fee_estimator,
4511                                 chain_monitor: nodes[0].chain_monitor,
4512                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4513                                 logger: nodes[0].logger,
4514                                 channel_monitors,
4515                         }).unwrap()
4516         };
4517         nodes_0_deserialized = nodes_0_deserialized_tmp;
4518
4519         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4520         check_added_monitors!(nodes[0], 1);
4521         nodes[0].node = &nodes_0_deserialized;
4522
4523         // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4524         // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4525         // payment events should kick in, leaving us with no pending events here.
4526         nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, nodes[0].blocks.lock().unwrap().len() as u32 - 1);
4527         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4528 }
4529
4530 #[test]
4531 fn test_manager_serialize_deserialize_events() {
4532         // This test makes sure the events field in ChannelManager survives de/serialization
4533         let chanmon_cfgs = create_chanmon_cfgs(2);
4534         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4535         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4536         let fee_estimator: test_utils::TestFeeEstimator;
4537         let persister: test_utils::TestPersister;
4538         let logger: test_utils::TestLogger;
4539         let new_chain_monitor: test_utils::TestChainMonitor;
4540         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4541         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4542
4543         // Start creating a channel, but stop right before broadcasting the funding transaction
4544         let channel_value = 100000;
4545         let push_msat = 10001;
4546         let a_flags = InitFeatures::known();
4547         let b_flags = InitFeatures::known();
4548         let node_a = nodes.remove(0);
4549         let node_b = nodes.remove(0);
4550         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4551         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()));
4552         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()));
4553
4554         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4555
4556         node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4557         check_added_monitors!(node_a, 0);
4558
4559         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()));
4560         {
4561                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4562                 assert_eq!(added_monitors.len(), 1);
4563                 assert_eq!(added_monitors[0].0, funding_output);
4564                 added_monitors.clear();
4565         }
4566
4567         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()));
4568         {
4569                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4570                 assert_eq!(added_monitors.len(), 1);
4571                 assert_eq!(added_monitors[0].0, funding_output);
4572                 added_monitors.clear();
4573         }
4574         // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4575
4576         nodes.push(node_a);
4577         nodes.push(node_b);
4578
4579         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4580         let nodes_0_serialized = nodes[0].node.encode();
4581         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4582         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4583
4584         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4585         logger = test_utils::TestLogger::new();
4586         persister = test_utils::TestPersister::new();
4587         let keys_manager = &chanmon_cfgs[0].keys_manager;
4588         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4589         nodes[0].chain_monitor = &new_chain_monitor;
4590         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4591         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4592                 &mut chan_0_monitor_read, keys_manager).unwrap();
4593         assert!(chan_0_monitor_read.is_empty());
4594
4595         let mut nodes_0_read = &nodes_0_serialized[..];
4596         let config = UserConfig::default();
4597         let (_, nodes_0_deserialized_tmp) = {
4598                 let mut channel_monitors = HashMap::new();
4599                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4600                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4601                         default_config: config,
4602                         keys_manager,
4603                         fee_estimator: &fee_estimator,
4604                         chain_monitor: nodes[0].chain_monitor,
4605                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4606                         logger: &logger,
4607                         channel_monitors,
4608                 }).unwrap()
4609         };
4610         nodes_0_deserialized = nodes_0_deserialized_tmp;
4611         assert!(nodes_0_read.is_empty());
4612
4613         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4614
4615         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4616         nodes[0].node = &nodes_0_deserialized;
4617
4618         // After deserializing, make sure the funding_transaction is still held by the channel manager
4619         let events_4 = nodes[0].node.get_and_clear_pending_events();
4620         assert_eq!(events_4.len(), 0);
4621         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4622         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4623
4624         // Make sure the channel is functioning as though the de/serialization never happened
4625         assert_eq!(nodes[0].node.list_channels().len(), 1);
4626         check_added_monitors!(nodes[0], 1);
4627
4628         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4629         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4630         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4631         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4632
4633         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4634         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4635         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4636         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4637
4638         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4639         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4640         for node in nodes.iter() {
4641                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4642                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4643                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4644         }
4645
4646         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4647 }
4648
4649 #[test]
4650 fn test_simple_manager_serialize_deserialize() {
4651         let chanmon_cfgs = create_chanmon_cfgs(2);
4652         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4653         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4654         let logger: test_utils::TestLogger;
4655         let fee_estimator: test_utils::TestFeeEstimator;
4656         let persister: test_utils::TestPersister;
4657         let new_chain_monitor: test_utils::TestChainMonitor;
4658         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4659         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4660         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4661
4662         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4663         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4664
4665         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4666
4667         let nodes_0_serialized = nodes[0].node.encode();
4668         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4669         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4670
4671         logger = test_utils::TestLogger::new();
4672         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4673         persister = test_utils::TestPersister::new();
4674         let keys_manager = &chanmon_cfgs[0].keys_manager;
4675         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4676         nodes[0].chain_monitor = &new_chain_monitor;
4677         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4678         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4679                 &mut chan_0_monitor_read, keys_manager).unwrap();
4680         assert!(chan_0_monitor_read.is_empty());
4681
4682         let mut nodes_0_read = &nodes_0_serialized[..];
4683         let (_, nodes_0_deserialized_tmp) = {
4684                 let mut channel_monitors = HashMap::new();
4685                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4686                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4687                         default_config: UserConfig::default(),
4688                         keys_manager,
4689                         fee_estimator: &fee_estimator,
4690                         chain_monitor: nodes[0].chain_monitor,
4691                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4692                         logger: &logger,
4693                         channel_monitors,
4694                 }).unwrap()
4695         };
4696         nodes_0_deserialized = nodes_0_deserialized_tmp;
4697         assert!(nodes_0_read.is_empty());
4698
4699         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4700         nodes[0].node = &nodes_0_deserialized;
4701         check_added_monitors!(nodes[0], 1);
4702
4703         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4704
4705         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4706         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4707 }
4708
4709 #[test]
4710 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4711         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4712         let chanmon_cfgs = create_chanmon_cfgs(4);
4713         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4714         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4715         let logger: test_utils::TestLogger;
4716         let fee_estimator: test_utils::TestFeeEstimator;
4717         let persister: test_utils::TestPersister;
4718         let new_chain_monitor: test_utils::TestChainMonitor;
4719         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4720         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4721         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4722         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4723         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4724
4725         let mut node_0_stale_monitors_serialized = Vec::new();
4726         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4727                 let mut writer = test_utils::TestVecWriter(Vec::new());
4728                 monitor.1.write(&mut writer).unwrap();
4729                 node_0_stale_monitors_serialized.push(writer.0);
4730         }
4731
4732         let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4733
4734         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4735         let nodes_0_serialized = nodes[0].node.encode();
4736
4737         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4738         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4739         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4740         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4741
4742         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4743         // nodes[3])
4744         let mut node_0_monitors_serialized = Vec::new();
4745         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4746                 let mut writer = test_utils::TestVecWriter(Vec::new());
4747                 monitor.1.write(&mut writer).unwrap();
4748                 node_0_monitors_serialized.push(writer.0);
4749         }
4750
4751         logger = test_utils::TestLogger::new();
4752         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4753         persister = test_utils::TestPersister::new();
4754         let keys_manager = &chanmon_cfgs[0].keys_manager;
4755         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4756         nodes[0].chain_monitor = &new_chain_monitor;
4757
4758
4759         let mut node_0_stale_monitors = Vec::new();
4760         for serialized in node_0_stale_monitors_serialized.iter() {
4761                 let mut read = &serialized[..];
4762                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4763                 assert!(read.is_empty());
4764                 node_0_stale_monitors.push(monitor);
4765         }
4766
4767         let mut node_0_monitors = Vec::new();
4768         for serialized in node_0_monitors_serialized.iter() {
4769                 let mut read = &serialized[..];
4770                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4771                 assert!(read.is_empty());
4772                 node_0_monitors.push(monitor);
4773         }
4774
4775         let mut nodes_0_read = &nodes_0_serialized[..];
4776         if let Err(msgs::DecodeError::InvalidValue) =
4777                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4778                 default_config: UserConfig::default(),
4779                 keys_manager,
4780                 fee_estimator: &fee_estimator,
4781                 chain_monitor: nodes[0].chain_monitor,
4782                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4783                 logger: &logger,
4784                 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4785         }) { } else {
4786                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4787         };
4788
4789         let mut nodes_0_read = &nodes_0_serialized[..];
4790         let (_, nodes_0_deserialized_tmp) =
4791                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4792                 default_config: UserConfig::default(),
4793                 keys_manager,
4794                 fee_estimator: &fee_estimator,
4795                 chain_monitor: nodes[0].chain_monitor,
4796                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4797                 logger: &logger,
4798                 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4799         }).unwrap();
4800         nodes_0_deserialized = nodes_0_deserialized_tmp;
4801         assert!(nodes_0_read.is_empty());
4802
4803         { // Channel close should result in a commitment tx and an HTLC tx
4804                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4805                 assert_eq!(txn.len(), 2);
4806                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4807                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4808         }
4809
4810         for monitor in node_0_monitors.drain(..) {
4811                 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4812                 check_added_monitors!(nodes[0], 1);
4813         }
4814         nodes[0].node = &nodes_0_deserialized;
4815
4816         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4817         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4818         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4819         //... and we can even still claim the payment!
4820         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4821
4822         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4823         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4824         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4825         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4826         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4827         assert_eq!(msg_events.len(), 1);
4828         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4829                 match action {
4830                         &ErrorAction::SendErrorMessage { ref msg } => {
4831                                 assert_eq!(msg.channel_id, channel_id);
4832                         },
4833                         _ => panic!("Unexpected event!"),
4834                 }
4835         }
4836 }
4837
4838 macro_rules! check_spendable_outputs {
4839         ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4840                 {
4841                         let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4842                         let mut txn = Vec::new();
4843                         let mut all_outputs = Vec::new();
4844                         let secp_ctx = Secp256k1::new();
4845                         for event in events.drain(..) {
4846                                 match event {
4847                                         Event::SpendableOutputs { mut outputs } => {
4848                                                 for outp in outputs.drain(..) {
4849                                                         txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4850                                                         all_outputs.push(outp);
4851                                                 }
4852                                         },
4853                                         _ => panic!("Unexpected event"),
4854                                 };
4855                         }
4856                         if all_outputs.len() > 1 {
4857                                 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) {
4858                                         txn.push(tx);
4859                                 }
4860                         }
4861                         txn
4862                 }
4863         }
4864 }
4865
4866 #[test]
4867 fn test_claim_sizeable_push_msat() {
4868         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4869         let chanmon_cfgs = create_chanmon_cfgs(2);
4870         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4871         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4872         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4873
4874         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4875         nodes[1].node.force_close_channel(&chan.2).unwrap();
4876         check_closed_broadcast!(nodes[1], true);
4877         check_added_monitors!(nodes[1], 1);
4878         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4879         assert_eq!(node_txn.len(), 1);
4880         check_spends!(node_txn[0], chan.3);
4881         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
4882
4883         mine_transaction(&nodes[1], &node_txn[0]);
4884         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4885
4886         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4887         assert_eq!(spend_txn.len(), 1);
4888         check_spends!(spend_txn[0], node_txn[0]);
4889 }
4890
4891 #[test]
4892 fn test_claim_on_remote_sizeable_push_msat() {
4893         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4894         // to_remote output is encumbered by a P2WPKH
4895         let chanmon_cfgs = create_chanmon_cfgs(2);
4896         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4897         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4898         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4899
4900         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4901         nodes[0].node.force_close_channel(&chan.2).unwrap();
4902         check_closed_broadcast!(nodes[0], true);
4903         check_added_monitors!(nodes[0], 1);
4904
4905         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4906         assert_eq!(node_txn.len(), 1);
4907         check_spends!(node_txn[0], chan.3);
4908         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
4909
4910         mine_transaction(&nodes[1], &node_txn[0]);
4911         check_closed_broadcast!(nodes[1], true);
4912         check_added_monitors!(nodes[1], 1);
4913         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4914
4915         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4916         assert_eq!(spend_txn.len(), 1);
4917         check_spends!(spend_txn[0], node_txn[0]);
4918 }
4919
4920 #[test]
4921 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4922         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4923         // to_remote output is encumbered by a P2WPKH
4924
4925         let chanmon_cfgs = create_chanmon_cfgs(2);
4926         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4927         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4928         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4929
4930         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4931         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4932         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4933         assert_eq!(revoked_local_txn[0].input.len(), 1);
4934         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4935
4936         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4937         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4938         check_closed_broadcast!(nodes[1], true);
4939         check_added_monitors!(nodes[1], 1);
4940
4941         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4942         mine_transaction(&nodes[1], &node_txn[0]);
4943         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4944
4945         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4946         assert_eq!(spend_txn.len(), 3);
4947         check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4948         check_spends!(spend_txn[1], node_txn[0]);
4949         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4950 }
4951
4952 #[test]
4953 fn test_static_spendable_outputs_preimage_tx() {
4954         let chanmon_cfgs = create_chanmon_cfgs(2);
4955         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4956         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4957         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4958
4959         // Create some initial channels
4960         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4961
4962         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4963
4964         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4965         assert_eq!(commitment_tx[0].input.len(), 1);
4966         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4967
4968         // Settle A's commitment tx on B's chain
4969         assert!(nodes[1].node.claim_funds(payment_preimage));
4970         check_added_monitors!(nodes[1], 1);
4971         mine_transaction(&nodes[1], &commitment_tx[0]);
4972         check_added_monitors!(nodes[1], 1);
4973         let events = nodes[1].node.get_and_clear_pending_msg_events();
4974         match events[0] {
4975                 MessageSendEvent::UpdateHTLCs { .. } => {},
4976                 _ => panic!("Unexpected event"),
4977         }
4978         match events[1] {
4979                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4980                 _ => panic!("Unexepected event"),
4981         }
4982
4983         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4984         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4985         assert_eq!(node_txn.len(), 3);
4986         check_spends!(node_txn[0], commitment_tx[0]);
4987         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4988         check_spends!(node_txn[1], chan_1.3);
4989         check_spends!(node_txn[2], node_txn[1]);
4990
4991         mine_transaction(&nodes[1], &node_txn[0]);
4992         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4993
4994         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4995         assert_eq!(spend_txn.len(), 1);
4996         check_spends!(spend_txn[0], node_txn[0]);
4997 }
4998
4999 #[test]
5000 fn test_static_spendable_outputs_timeout_tx() {
5001         let chanmon_cfgs = create_chanmon_cfgs(2);
5002         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5003         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5004         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5005
5006         // Create some initial channels
5007         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5008
5009         // Rebalance the network a bit by relaying one payment through all the channels ...
5010         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5011
5012         let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
5013
5014         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5015         assert_eq!(commitment_tx[0].input.len(), 1);
5016         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
5017
5018         // Settle A's commitment tx on B' chain
5019         mine_transaction(&nodes[1], &commitment_tx[0]);
5020         check_added_monitors!(nodes[1], 1);
5021         let events = nodes[1].node.get_and_clear_pending_msg_events();
5022         match events[0] {
5023                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5024                 _ => panic!("Unexpected event"),
5025         }
5026         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5027
5028         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
5029         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
5030         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
5031         check_spends!(node_txn[0], chan_1.3.clone());
5032         check_spends!(node_txn[1], node_txn[0]);
5033         check_spends!(node_txn[2],  commitment_tx[0].clone());
5034         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5035
5036         mine_transaction(&nodes[1], &node_txn[2]);
5037         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5038         expect_payment_failed!(nodes[1], our_payment_hash, true);
5039
5040         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5041         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
5042         check_spends!(spend_txn[0], commitment_tx[0]);
5043         check_spends!(spend_txn[1], node_txn[2]);
5044         check_spends!(spend_txn[2], node_txn[2], commitment_tx[0]); // All outputs
5045 }
5046
5047 #[test]
5048 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
5049         let chanmon_cfgs = create_chanmon_cfgs(2);
5050         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5051         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5052         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5053
5054         // Create some initial channels
5055         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5056
5057         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5058         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5059         assert_eq!(revoked_local_txn[0].input.len(), 1);
5060         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5061
5062         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5063
5064         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5065         check_closed_broadcast!(nodes[1], true);
5066         check_added_monitors!(nodes[1], 1);
5067
5068         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5069         assert_eq!(node_txn.len(), 2);
5070         assert_eq!(node_txn[0].input.len(), 2);
5071         check_spends!(node_txn[0], revoked_local_txn[0]);
5072
5073         mine_transaction(&nodes[1], &node_txn[0]);
5074         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5075
5076         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5077         assert_eq!(spend_txn.len(), 1);
5078         check_spends!(spend_txn[0], node_txn[0]);
5079 }
5080
5081 #[test]
5082 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5083         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5084         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
5085         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5086         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5087         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5088
5089         // Create some initial channels
5090         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5091
5092         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5093         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5094         assert_eq!(revoked_local_txn[0].input.len(), 1);
5095         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5096
5097         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5098
5099         // A will generate HTLC-Timeout from revoked commitment tx
5100         mine_transaction(&nodes[0], &revoked_local_txn[0]);
5101         check_closed_broadcast!(nodes[0], true);
5102         check_added_monitors!(nodes[0], 1);
5103         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5104
5105         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5106         assert_eq!(revoked_htlc_txn.len(), 2);
5107         check_spends!(revoked_htlc_txn[0], chan_1.3);
5108         assert_eq!(revoked_htlc_txn[1].input.len(), 1);
5109         assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5110         check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
5111         assert_ne!(revoked_htlc_txn[1].lock_time, 0); // HTLC-Timeout
5112
5113         // B will generate justice tx from A's revoked commitment/HTLC tx
5114         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5115         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
5116         check_closed_broadcast!(nodes[1], true);
5117         check_added_monitors!(nodes[1], 1);
5118
5119         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5120         assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
5121         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5122         // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
5123         // transactions next...
5124         assert_eq!(node_txn[0].input.len(), 3);
5125         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
5126
5127         assert_eq!(node_txn[1].input.len(), 2);
5128         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
5129         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
5130                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5131         } else {
5132                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
5133                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5134         }
5135
5136         assert_eq!(node_txn[2].input.len(), 1);
5137         check_spends!(node_txn[2], chan_1.3);
5138
5139         mine_transaction(&nodes[1], &node_txn[1]);
5140         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5141
5142         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5143         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5144         assert_eq!(spend_txn.len(), 1);
5145         assert_eq!(spend_txn[0].input.len(), 1);
5146         check_spends!(spend_txn[0], node_txn[1]);
5147 }
5148
5149 #[test]
5150 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5151         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5152         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
5153         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5154         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5155         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5156
5157         // Create some initial channels
5158         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5159
5160         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5161         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5162         assert_eq!(revoked_local_txn[0].input.len(), 1);
5163         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5164
5165         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5166         assert_eq!(revoked_local_txn[0].output.len(), 2);
5167
5168         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5169
5170         // B will generate HTLC-Success from revoked commitment tx
5171         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5172         check_closed_broadcast!(nodes[1], true);
5173         check_added_monitors!(nodes[1], 1);
5174         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5175
5176         assert_eq!(revoked_htlc_txn.len(), 2);
5177         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5178         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5179         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5180
5181         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5182         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5183         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5184
5185         // A will generate justice tx from B's revoked commitment/HTLC tx
5186         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5187         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5188         check_closed_broadcast!(nodes[0], true);
5189         check_added_monitors!(nodes[0], 1);
5190
5191         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5192         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5193
5194         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5195         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5196         // transactions next...
5197         assert_eq!(node_txn[0].input.len(), 2);
5198         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5199         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5200                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5201         } else {
5202                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5203                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5204         }
5205
5206         assert_eq!(node_txn[1].input.len(), 1);
5207         check_spends!(node_txn[1], revoked_htlc_txn[0]);
5208
5209         check_spends!(node_txn[2], chan_1.3);
5210
5211         mine_transaction(&nodes[0], &node_txn[1]);
5212         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5213
5214         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5215         // didn't try to generate any new transactions.
5216
5217         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5218         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5219         assert_eq!(spend_txn.len(), 3);
5220         assert_eq!(spend_txn[0].input.len(), 1);
5221         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5222         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5223         check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5224         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5225 }
5226
5227 #[test]
5228 fn test_onchain_to_onchain_claim() {
5229         // Test that in case of channel closure, we detect the state of output and claim HTLC
5230         // on downstream peer's remote commitment tx.
5231         // First, have C claim an HTLC against its own latest commitment transaction.
5232         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5233         // channel.
5234         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5235         // gets broadcast.
5236
5237         let chanmon_cfgs = create_chanmon_cfgs(3);
5238         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5239         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5240         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5241
5242         // Create some initial channels
5243         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5244         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5245
5246         // Ensure all nodes are at the same height
5247         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5248         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5249         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5250         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5251
5252         // Rebalance the network a bit by relaying one payment through all the channels ...
5253         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5254         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5255
5256         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5257         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5258         check_spends!(commitment_tx[0], chan_2.3);
5259         nodes[2].node.claim_funds(payment_preimage);
5260         check_added_monitors!(nodes[2], 1);
5261         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5262         assert!(updates.update_add_htlcs.is_empty());
5263         assert!(updates.update_fail_htlcs.is_empty());
5264         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5265         assert!(updates.update_fail_malformed_htlcs.is_empty());
5266
5267         mine_transaction(&nodes[2], &commitment_tx[0]);
5268         check_closed_broadcast!(nodes[2], true);
5269         check_added_monitors!(nodes[2], 1);
5270
5271         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5272         assert_eq!(c_txn.len(), 3);
5273         assert_eq!(c_txn[0], c_txn[2]);
5274         assert_eq!(commitment_tx[0], c_txn[1]);
5275         check_spends!(c_txn[1], chan_2.3);
5276         check_spends!(c_txn[2], c_txn[1]);
5277         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5278         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5279         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5280         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5281
5282         // 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
5283         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5284         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5285         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5286         {
5287                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5288                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
5289                 assert_eq!(b_txn.len(), 3);
5290                 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
5291                 check_spends!(b_txn[1], b_txn[0]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5292                 assert_eq!(b_txn[1].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5293                 assert!(b_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5294                 assert_ne!(b_txn[1].lock_time, 0); // Timeout tx
5295                 check_spends!(b_txn[2], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5296                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5297                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5298                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5299                 b_txn.clear();
5300         }
5301         check_added_monitors!(nodes[1], 1);
5302         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5303         assert_eq!(msg_events.len(), 3);
5304         check_added_monitors!(nodes[1], 1);
5305         match msg_events[0] {
5306                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5307                 _ => panic!("Unexpected event"),
5308         }
5309         match msg_events[1] {
5310                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5311                 _ => panic!("Unexpected event"),
5312         }
5313         match msg_events[2] {
5314                 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, .. } } => {
5315                         assert!(update_add_htlcs.is_empty());
5316                         assert!(update_fail_htlcs.is_empty());
5317                         assert_eq!(update_fulfill_htlcs.len(), 1);
5318                         assert!(update_fail_malformed_htlcs.is_empty());
5319                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5320                 },
5321                 _ => panic!("Unexpected event"),
5322         };
5323         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5324         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5325         mine_transaction(&nodes[1], &commitment_tx[0]);
5326         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5327         // ChannelMonitor: HTLC-Success tx + HTLC-Timeout RBF Bump, ChannelManager: local commitment tx + HTLC-Success tx
5328         assert_eq!(b_txn.len(), 4);
5329         check_spends!(b_txn[2], chan_1.3);
5330         check_spends!(b_txn[3], b_txn[2]);
5331         let (htlc_success_claim, htlc_timeout_bumped) =
5332                 if b_txn[0].input[0].previous_output.txid == commitment_tx[0].txid()
5333                         { (&b_txn[0], &b_txn[1]) } else { (&b_txn[1], &b_txn[0]) };
5334         check_spends!(htlc_success_claim, commitment_tx[0]);
5335         assert_eq!(htlc_success_claim.input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5336         assert!(htlc_success_claim.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5337         assert_eq!(htlc_success_claim.lock_time, 0); // Success tx
5338         check_spends!(htlc_timeout_bumped, c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5339         assert_ne!(htlc_timeout_bumped.lock_time, 0); // Success tx
5340
5341         check_closed_broadcast!(nodes[1], true);
5342         check_added_monitors!(nodes[1], 1);
5343 }
5344
5345 #[test]
5346 fn test_duplicate_payment_hash_one_failure_one_success() {
5347         // Topology : A --> B --> C --> D
5348         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5349         // Note that because C will refuse to generate two payment secrets for the same payment hash,
5350         // we forward one of the payments onwards to D.
5351         let chanmon_cfgs = create_chanmon_cfgs(4);
5352         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5353         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
5354         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5355
5356         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5357         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5358         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5359
5360         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5361         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5362         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5363         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5364         connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
5365
5366         let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5367
5368         let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5369         // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5370         // script push size limit so that the below script length checks match
5371         // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5372         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
5373                 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV - 40, nodes[0].logger).unwrap();
5374         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5375
5376         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5377         assert_eq!(commitment_txn[0].input.len(), 1);
5378         check_spends!(commitment_txn[0], chan_2.3);
5379
5380         mine_transaction(&nodes[1], &commitment_txn[0]);
5381         check_closed_broadcast!(nodes[1], true);
5382         check_added_monitors!(nodes[1], 1);
5383         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
5384
5385         let htlc_timeout_tx;
5386         { // Extract one of the two HTLC-Timeout transaction
5387                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5388                 // ChannelMonitor: timeout tx * 3, ChannelManager: local commitment tx + HTLC-timeout * 2
5389                 assert_eq!(node_txn.len(), 6);
5390                 check_spends!(node_txn[0], chan_2.3);
5391                 check_spends!(node_txn[1], node_txn[0]);
5392                 check_spends!(node_txn[2], node_txn[0]);
5393
5394                 check_spends!(node_txn[3], commitment_txn[0]);
5395                 assert_eq!(node_txn[3].input.len(), 1);
5396                 check_spends!(node_txn[4], commitment_txn[0]);
5397                 assert_eq!(node_txn[4].input.len(), 1);
5398                 assert_eq!(node_txn[3].input[0].previous_output, node_txn[4].input[0].previous_output);
5399                 check_spends!(node_txn[5], commitment_txn[0]);
5400                 assert_ne!(node_txn[3].input[0].previous_output, node_txn[5].input[0].previous_output);
5401
5402                 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5403                 assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5404                 assert_eq!(node_txn[5].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5405                 htlc_timeout_tx = node_txn[3].clone();
5406         }
5407
5408         nodes[2].node.claim_funds(our_payment_preimage);
5409         mine_transaction(&nodes[2], &commitment_txn[0]);
5410         check_added_monitors!(nodes[2], 2);
5411         let events = nodes[2].node.get_and_clear_pending_msg_events();
5412         match events[0] {
5413                 MessageSendEvent::UpdateHTLCs { .. } => {},
5414                 _ => panic!("Unexpected event"),
5415         }
5416         match events[1] {
5417                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5418                 _ => panic!("Unexepected event"),
5419         }
5420         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5421         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)
5422         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5423         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5424         assert_eq!(htlc_success_txn[0].input.len(), 1);
5425         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5426         assert_eq!(htlc_success_txn[1].input.len(), 1);
5427         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5428         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5429         assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5430         assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5431         assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5432         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5433
5434         mine_transaction(&nodes[1], &htlc_timeout_tx);
5435         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5436         expect_pending_htlcs_forwardable!(nodes[1]);
5437         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5438         assert!(htlc_updates.update_add_htlcs.is_empty());
5439         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5440         let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5441         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5442         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5443         check_added_monitors!(nodes[1], 1);
5444
5445         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5446         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5447         {
5448                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5449                 let events = nodes[0].node.get_and_clear_pending_msg_events();
5450                 assert_eq!(events.len(), 1);
5451                 match events[0] {
5452                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
5453                         },
5454                         _ => { panic!("Unexpected event"); }
5455                 }
5456         }
5457         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5458
5459         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5460         mine_transaction(&nodes[1], &htlc_success_txn[0]);
5461         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5462         assert!(updates.update_add_htlcs.is_empty());
5463         assert!(updates.update_fail_htlcs.is_empty());
5464         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5465         assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5466         assert!(updates.update_fail_malformed_htlcs.is_empty());
5467         check_added_monitors!(nodes[1], 1);
5468
5469         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5470         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5471
5472         let events = nodes[0].node.get_and_clear_pending_events();
5473         match events[0] {
5474                 Event::PaymentSent { ref payment_preimage } => {
5475                         assert_eq!(*payment_preimage, our_payment_preimage);
5476                 }
5477                 _ => panic!("Unexpected event"),
5478         }
5479 }
5480
5481 #[test]
5482 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5483         let chanmon_cfgs = create_chanmon_cfgs(2);
5484         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5485         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5486         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5487
5488         // Create some initial channels
5489         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5490
5491         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5492         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5493         assert_eq!(local_txn.len(), 1);
5494         assert_eq!(local_txn[0].input.len(), 1);
5495         check_spends!(local_txn[0], chan_1.3);
5496
5497         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5498         nodes[1].node.claim_funds(payment_preimage);
5499         check_added_monitors!(nodes[1], 1);
5500         mine_transaction(&nodes[1], &local_txn[0]);
5501         check_added_monitors!(nodes[1], 1);
5502         let events = nodes[1].node.get_and_clear_pending_msg_events();
5503         match events[0] {
5504                 MessageSendEvent::UpdateHTLCs { .. } => {},
5505                 _ => panic!("Unexpected event"),
5506         }
5507         match events[1] {
5508                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5509                 _ => panic!("Unexepected event"),
5510         }
5511         let node_tx = {
5512                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5513                 assert_eq!(node_txn.len(), 3);
5514                 assert_eq!(node_txn[0], node_txn[2]);
5515                 assert_eq!(node_txn[1], local_txn[0]);
5516                 assert_eq!(node_txn[0].input.len(), 1);
5517                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5518                 check_spends!(node_txn[0], local_txn[0]);
5519                 node_txn[0].clone()
5520         };
5521
5522         mine_transaction(&nodes[1], &node_tx);
5523         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5524
5525         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5526         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5527         assert_eq!(spend_txn.len(), 1);
5528         check_spends!(spend_txn[0], node_tx);
5529 }
5530
5531 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5532         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5533         // unrevoked commitment transaction.
5534         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5535         // a remote RAA before they could be failed backwards (and combinations thereof).
5536         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5537         // use the same payment hashes.
5538         // Thus, we use a six-node network:
5539         //
5540         // A \         / E
5541         //    - C - D -
5542         // B /         \ F
5543         // And test where C fails back to A/B when D announces its latest commitment transaction
5544         let chanmon_cfgs = create_chanmon_cfgs(6);
5545         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5546         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5547         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5548         let logger = test_utils::TestLogger::new();
5549
5550         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5551         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5552         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5553         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5554         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5555
5556         // Rebalance and check output sanity...
5557         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5558         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5559         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5560
5561         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5562         // 0th HTLC:
5563         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
5564         // 1st HTLC:
5565         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
5566         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5567         let our_node_id = &nodes[1].node.get_our_node_id();
5568         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();
5569         // 2nd HTLC:
5570         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
5571         // 3rd HTLC:
5572         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
5573         // 4th HTLC:
5574         let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5575         // 5th HTLC:
5576         let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5577         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();
5578         // 6th HTLC:
5579         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());
5580         // 7th HTLC:
5581         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());
5582
5583         // 8th HTLC:
5584         let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5585         // 9th HTLC:
5586         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();
5587         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
5588
5589         // 10th HTLC:
5590         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
5591         // 11th HTLC:
5592         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();
5593         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());
5594
5595         // Double-check that six of the new HTLC were added
5596         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5597         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5598         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5599         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5600
5601         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5602         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5603         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5604         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5605         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5606         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5607         check_added_monitors!(nodes[4], 0);
5608         expect_pending_htlcs_forwardable!(nodes[4]);
5609         check_added_monitors!(nodes[4], 1);
5610
5611         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5612         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5613         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5614         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5615         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5616         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5617
5618         // Fail 3rd below-dust and 7th above-dust HTLCs
5619         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5620         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5621         check_added_monitors!(nodes[5], 0);
5622         expect_pending_htlcs_forwardable!(nodes[5]);
5623         check_added_monitors!(nodes[5], 1);
5624
5625         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5626         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5627         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5628         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5629
5630         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5631
5632         expect_pending_htlcs_forwardable!(nodes[3]);
5633         check_added_monitors!(nodes[3], 1);
5634         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5635         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5636         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5637         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5638         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5639         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5640         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5641         if deliver_last_raa {
5642                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5643         } else {
5644                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5645         }
5646
5647         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5648         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5649         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5650         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5651         //
5652         // We now broadcast the latest commitment transaction, which *should* result in failures for
5653         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5654         // the non-broadcast above-dust HTLCs.
5655         //
5656         // Alternatively, we may broadcast the previous commitment transaction, which should only
5657         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5658         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5659
5660         if announce_latest {
5661                 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5662         } else {
5663                 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5664         }
5665         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5666         check_closed_broadcast!(nodes[2], true);
5667         expect_pending_htlcs_forwardable!(nodes[2]);
5668         check_added_monitors!(nodes[2], 3);
5669
5670         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5671         assert_eq!(cs_msgs.len(), 2);
5672         let mut a_done = false;
5673         for msg in cs_msgs {
5674                 match msg {
5675                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5676                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5677                                 // should be failed-backwards here.
5678                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5679                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5680                                         for htlc in &updates.update_fail_htlcs {
5681                                                 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 });
5682                                         }
5683                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5684                                         assert!(!a_done);
5685                                         a_done = true;
5686                                         &nodes[0]
5687                                 } else {
5688                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5689                                         for htlc in &updates.update_fail_htlcs {
5690                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5691                                         }
5692                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5693                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5694                                         &nodes[1]
5695                                 };
5696                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5697                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5698                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5699                                 if announce_latest {
5700                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5701                                         if *node_id == nodes[0].node.get_our_node_id() {
5702                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5703                                         }
5704                                 }
5705                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5706                         },
5707                         _ => panic!("Unexpected event"),
5708                 }
5709         }
5710
5711         let as_events = nodes[0].node.get_and_clear_pending_events();
5712         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5713         let mut as_failds = HashSet::new();
5714         for event in as_events.iter() {
5715                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5716                         assert!(as_failds.insert(*payment_hash));
5717                         if *payment_hash != payment_hash_2 {
5718                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5719                         } else {
5720                                 assert!(!rejected_by_dest);
5721                         }
5722                 } else { panic!("Unexpected event"); }
5723         }
5724         assert!(as_failds.contains(&payment_hash_1));
5725         assert!(as_failds.contains(&payment_hash_2));
5726         if announce_latest {
5727                 assert!(as_failds.contains(&payment_hash_3));
5728                 assert!(as_failds.contains(&payment_hash_5));
5729         }
5730         assert!(as_failds.contains(&payment_hash_6));
5731
5732         let bs_events = nodes[1].node.get_and_clear_pending_events();
5733         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5734         let mut bs_failds = HashSet::new();
5735         for event in bs_events.iter() {
5736                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5737                         assert!(bs_failds.insert(*payment_hash));
5738                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5739                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5740                         } else {
5741                                 assert!(!rejected_by_dest);
5742                         }
5743                 } else { panic!("Unexpected event"); }
5744         }
5745         assert!(bs_failds.contains(&payment_hash_1));
5746         assert!(bs_failds.contains(&payment_hash_2));
5747         if announce_latest {
5748                 assert!(bs_failds.contains(&payment_hash_4));
5749         }
5750         assert!(bs_failds.contains(&payment_hash_5));
5751
5752         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5753         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5754         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5755         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5756         // PaymentFailureNetworkUpdates.
5757         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5758         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5759         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5760         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5761         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5762                 match event {
5763                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5764                         _ => panic!("Unexpected event"),
5765                 }
5766         }
5767 }
5768
5769 #[test]
5770 fn test_fail_backwards_latest_remote_announce_a() {
5771         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5772 }
5773
5774 #[test]
5775 fn test_fail_backwards_latest_remote_announce_b() {
5776         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5777 }
5778
5779 #[test]
5780 fn test_fail_backwards_previous_remote_announce() {
5781         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5782         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5783         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5784 }
5785
5786 #[test]
5787 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5788         let chanmon_cfgs = create_chanmon_cfgs(2);
5789         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5790         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5791         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5792
5793         // Create some initial channels
5794         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5795
5796         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5797         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5798         assert_eq!(local_txn[0].input.len(), 1);
5799         check_spends!(local_txn[0], chan_1.3);
5800
5801         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5802         mine_transaction(&nodes[0], &local_txn[0]);
5803         check_closed_broadcast!(nodes[0], true);
5804         check_added_monitors!(nodes[0], 1);
5805         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5806
5807         let htlc_timeout = {
5808                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5809                 assert_eq!(node_txn.len(), 3);
5810                 check_spends!(node_txn[0], chan_1.3);
5811                 assert_eq!(node_txn[1], node_txn[2]);
5812                 assert_eq!(node_txn[1].input.len(), 1);
5813                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5814                 check_spends!(node_txn[1], local_txn[0]);
5815                 node_txn[1].clone()
5816         };
5817
5818         mine_transaction(&nodes[0], &htlc_timeout);
5819         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5820         expect_payment_failed!(nodes[0], our_payment_hash, true);
5821
5822         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5823         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5824         assert_eq!(spend_txn.len(), 3);
5825         check_spends!(spend_txn[0], local_txn[0]);
5826         check_spends!(spend_txn[1], htlc_timeout);
5827         check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5828 }
5829
5830 #[test]
5831 fn test_key_derivation_params() {
5832         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5833         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5834         // let us re-derive the channel key set to then derive a delayed_payment_key.
5835
5836         let chanmon_cfgs = create_chanmon_cfgs(3);
5837
5838         // We manually create the node configuration to backup the seed.
5839         let seed = [42; 32];
5840         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5841         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);
5842         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 };
5843         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5844         node_cfgs.remove(0);
5845         node_cfgs.insert(0, node);
5846
5847         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5848         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5849
5850         // Create some initial channels
5851         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5852         // for node 0
5853         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5854         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5855         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5856
5857         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5858         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5859         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5860         assert_eq!(local_txn_1[0].input.len(), 1);
5861         check_spends!(local_txn_1[0], chan_1.3);
5862
5863         // We check funding pubkey are unique
5864         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]));
5865         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]));
5866         if from_0_funding_key_0 == from_1_funding_key_0
5867             || from_0_funding_key_0 == from_1_funding_key_1
5868             || from_0_funding_key_1 == from_1_funding_key_0
5869             || from_0_funding_key_1 == from_1_funding_key_1 {
5870                 panic!("Funding pubkeys aren't unique");
5871         }
5872
5873         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5874         mine_transaction(&nodes[0], &local_txn_1[0]);
5875         check_closed_broadcast!(nodes[0], true);
5876         check_added_monitors!(nodes[0], 1);
5877
5878         let htlc_timeout = {
5879                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5880                 assert_eq!(node_txn[1].input.len(), 1);
5881                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5882                 check_spends!(node_txn[1], local_txn_1[0]);
5883                 node_txn[1].clone()
5884         };
5885
5886         mine_transaction(&nodes[0], &htlc_timeout);
5887         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5888         expect_payment_failed!(nodes[0], our_payment_hash, true);
5889
5890         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5891         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5892         let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5893         assert_eq!(spend_txn.len(), 3);
5894         check_spends!(spend_txn[0], local_txn_1[0]);
5895         check_spends!(spend_txn[1], htlc_timeout);
5896         check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5897 }
5898
5899 #[test]
5900 fn test_static_output_closing_tx() {
5901         let chanmon_cfgs = create_chanmon_cfgs(2);
5902         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5903         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5904         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5905
5906         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5907
5908         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5909         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5910
5911         mine_transaction(&nodes[0], &closing_tx);
5912         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5913
5914         let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5915         assert_eq!(spend_txn.len(), 1);
5916         check_spends!(spend_txn[0], closing_tx);
5917
5918         mine_transaction(&nodes[1], &closing_tx);
5919         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5920
5921         let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5922         assert_eq!(spend_txn.len(), 1);
5923         check_spends!(spend_txn[0], closing_tx);
5924 }
5925
5926 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5927         let chanmon_cfgs = create_chanmon_cfgs(2);
5928         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5929         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5930         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5931         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5932
5933         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5934
5935         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5936         // present in B's local commitment transaction, but none of A's commitment transactions.
5937         assert!(nodes[1].node.claim_funds(our_payment_preimage));
5938         check_added_monitors!(nodes[1], 1);
5939
5940         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5941         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5942         let events = nodes[0].node.get_and_clear_pending_events();
5943         assert_eq!(events.len(), 1);
5944         match events[0] {
5945                 Event::PaymentSent { payment_preimage } => {
5946                         assert_eq!(payment_preimage, our_payment_preimage);
5947                 },
5948                 _ => panic!("Unexpected event"),
5949         }
5950
5951         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5952         check_added_monitors!(nodes[0], 1);
5953         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5954         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5955         check_added_monitors!(nodes[1], 1);
5956
5957         let starting_block = nodes[1].best_block_info();
5958         let mut block = Block {
5959                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5960                 txdata: vec![],
5961         };
5962         for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5963                 connect_block(&nodes[1], &block);
5964                 block.header.prev_blockhash = block.block_hash();
5965         }
5966         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5967         check_closed_broadcast!(nodes[1], true);
5968         check_added_monitors!(nodes[1], 1);
5969 }
5970
5971 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5972         let chanmon_cfgs = create_chanmon_cfgs(2);
5973         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5974         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5975         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5976         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5977         let logger = test_utils::TestLogger::new();
5978
5979         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
5980         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5981         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();
5982         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5983         check_added_monitors!(nodes[0], 1);
5984
5985         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5986
5987         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5988         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5989         // to "time out" the HTLC.
5990
5991         let starting_block = nodes[1].best_block_info();
5992         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5993
5994         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5995                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5996                 header.prev_blockhash = header.block_hash();
5997         }
5998         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5999         check_closed_broadcast!(nodes[0], true);
6000         check_added_monitors!(nodes[0], 1);
6001 }
6002
6003 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
6004         let chanmon_cfgs = create_chanmon_cfgs(3);
6005         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6006         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6007         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6008         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6009
6010         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
6011         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
6012         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
6013         // actually revoked.
6014         let htlc_value = if use_dust { 50000 } else { 3000000 };
6015         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
6016         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
6017         expect_pending_htlcs_forwardable!(nodes[1]);
6018         check_added_monitors!(nodes[1], 1);
6019
6020         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6021         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
6022         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
6023         check_added_monitors!(nodes[0], 1);
6024         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6025         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
6026         check_added_monitors!(nodes[1], 1);
6027         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
6028         check_added_monitors!(nodes[1], 1);
6029         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6030
6031         if check_revoke_no_close {
6032                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
6033                 check_added_monitors!(nodes[0], 1);
6034         }
6035
6036         let starting_block = nodes[1].best_block_info();
6037         let mut block = Block {
6038                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6039                 txdata: vec![],
6040         };
6041         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
6042                 connect_block(&nodes[0], &block);
6043                 block.header.prev_blockhash = block.block_hash();
6044         }
6045         if !check_revoke_no_close {
6046                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6047                 check_closed_broadcast!(nodes[0], true);
6048                 check_added_monitors!(nodes[0], 1);
6049         } else {
6050                 expect_payment_failed!(nodes[0], our_payment_hash, true);
6051         }
6052 }
6053
6054 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
6055 // There are only a few cases to test here:
6056 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
6057 //    broadcastable commitment transactions result in channel closure,
6058 //  * its included in an unrevoked-but-previous remote commitment transaction,
6059 //  * its included in the latest remote or local commitment transactions.
6060 // We test each of the three possible commitment transactions individually and use both dust and
6061 // non-dust HTLCs.
6062 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
6063 // assume they are handled the same across all six cases, as both outbound and inbound failures are
6064 // tested for at least one of the cases in other tests.
6065 #[test]
6066 fn htlc_claim_single_commitment_only_a() {
6067         do_htlc_claim_local_commitment_only(true);
6068         do_htlc_claim_local_commitment_only(false);
6069
6070         do_htlc_claim_current_remote_commitment_only(true);
6071         do_htlc_claim_current_remote_commitment_only(false);
6072 }
6073
6074 #[test]
6075 fn htlc_claim_single_commitment_only_b() {
6076         do_htlc_claim_previous_remote_commitment_only(true, false);
6077         do_htlc_claim_previous_remote_commitment_only(false, false);
6078         do_htlc_claim_previous_remote_commitment_only(true, true);
6079         do_htlc_claim_previous_remote_commitment_only(false, true);
6080 }
6081
6082 #[test]
6083 #[should_panic]
6084 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6085         let chanmon_cfgs = create_chanmon_cfgs(2);
6086         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6087         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6088         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6089         //Force duplicate channel ids
6090         for node in nodes.iter() {
6091                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6092         }
6093
6094         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6095         let channel_value_satoshis=10000;
6096         let push_msat=10001;
6097         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6098         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6099         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6100
6101         //Create a second channel with a channel_id collision
6102         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6103 }
6104
6105 #[test]
6106 fn bolt2_open_channel_sending_node_checks_part2() {
6107         let chanmon_cfgs = create_chanmon_cfgs(2);
6108         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6109         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6110         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6111
6112         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6113         let channel_value_satoshis=2^24;
6114         let push_msat=10001;
6115         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6116
6117         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6118         let channel_value_satoshis=10000;
6119         // Test when push_msat is equal to 1000 * funding_satoshis.
6120         let push_msat=1000*channel_value_satoshis+1;
6121         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6122
6123         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6124         let channel_value_satoshis=10000;
6125         let push_msat=10001;
6126         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
6127         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6128         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6129
6130         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6131         // 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
6132         assert!(node0_to_1_send_open_channel.channel_flags<=1);
6133
6134         // 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.
6135         assert!(BREAKDOWN_TIMEOUT>0);
6136         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6137
6138         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6139         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6140         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6141
6142         // 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.
6143         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6144         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6145         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6146         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6147         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6148 }
6149
6150 #[test]
6151 fn bolt2_open_channel_sane_dust_limit() {
6152         let chanmon_cfgs = create_chanmon_cfgs(2);
6153         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6154         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6155         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6156
6157         let channel_value_satoshis=1000000;
6158         let push_msat=10001;
6159         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6160         let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6161         node0_to_1_send_open_channel.dust_limit_satoshis = 661;
6162         node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
6163
6164         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6165         let events = nodes[1].node.get_and_clear_pending_msg_events();
6166         let err_msg = match events[0] {
6167                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
6168                         msg.clone()
6169                 },
6170                 _ => panic!("Unexpected event"),
6171         };
6172         assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
6173 }
6174
6175 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6176 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6177 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6178 // is no longer affordable once it's freed.
6179 #[test]
6180 fn test_fail_holding_cell_htlc_upon_free() {
6181         let chanmon_cfgs = create_chanmon_cfgs(2);
6182         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6183         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6184         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6185         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6186         let logger = test_utils::TestLogger::new();
6187
6188         // First nodes[0] generates an update_fee, setting the channel's
6189         // pending_update_fee.
6190         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6191         check_added_monitors!(nodes[0], 1);
6192
6193         let events = nodes[0].node.get_and_clear_pending_msg_events();
6194         assert_eq!(events.len(), 1);
6195         let (update_msg, commitment_signed) = match events[0] {
6196                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6197                         (update_fee.as_ref(), commitment_signed)
6198                 },
6199                 _ => panic!("Unexpected event"),
6200         };
6201
6202         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6203
6204         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6205         let channel_reserve = chan_stat.channel_reserve_msat;
6206         let feerate = get_feerate!(nodes[0], chan.2);
6207
6208         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6209         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6210         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6211         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6212         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();
6213
6214         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6215         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6216         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6217         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6218
6219         // Flush the pending fee update.
6220         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6221         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6222         check_added_monitors!(nodes[1], 1);
6223         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6224         check_added_monitors!(nodes[0], 1);
6225
6226         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6227         // HTLC, but now that the fee has been raised the payment will now fail, causing
6228         // us to surface its failure to the user.
6229         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6230         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6231         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 1 HTLC updates".to_string(), 1);
6232         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);
6233         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6234
6235         // Check that the payment failed to be sent out.
6236         let events = nodes[0].node.get_and_clear_pending_events();
6237         assert_eq!(events.len(), 1);
6238         match &events[0] {
6239                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6240                         assert_eq!(our_payment_hash.clone(), *payment_hash);
6241                         assert_eq!(*rejected_by_dest, false);
6242                         assert_eq!(*error_code, None);
6243                         assert_eq!(*error_data, None);
6244                 },
6245                 _ => panic!("Unexpected event"),
6246         }
6247 }
6248
6249 // Test that if multiple HTLCs are released from the holding cell and one is
6250 // valid but the other is no longer valid upon release, the valid HTLC can be
6251 // successfully completed while the other one fails as expected.
6252 #[test]
6253 fn test_free_and_fail_holding_cell_htlcs() {
6254         let chanmon_cfgs = create_chanmon_cfgs(2);
6255         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6256         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6257         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6258         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6259         let logger = test_utils::TestLogger::new();
6260
6261         // First nodes[0] generates an update_fee, setting the channel's
6262         // pending_update_fee.
6263         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6264         check_added_monitors!(nodes[0], 1);
6265
6266         let events = nodes[0].node.get_and_clear_pending_msg_events();
6267         assert_eq!(events.len(), 1);
6268         let (update_msg, commitment_signed) = match events[0] {
6269                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6270                         (update_fee.as_ref(), commitment_signed)
6271                 },
6272                 _ => panic!("Unexpected event"),
6273         };
6274
6275         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6276
6277         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6278         let channel_reserve = chan_stat.channel_reserve_msat;
6279         let feerate = get_feerate!(nodes[0], chan.2);
6280
6281         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6282         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6283         let amt_1 = 20000;
6284         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6285         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6286         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6287         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();
6288         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();
6289
6290         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6291         nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6292         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6293         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6294         nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6295         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6296         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6297
6298         // Flush the pending fee update.
6299         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6300         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6301         check_added_monitors!(nodes[1], 1);
6302         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6303         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6304         check_added_monitors!(nodes[0], 2);
6305
6306         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6307         // but now that the fee has been raised the second payment will now fail, causing us
6308         // to surface its failure to the user. The first payment should succeed.
6309         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6310         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6311         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 2 HTLC updates".to_string(), 1);
6312         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);
6313         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6314
6315         // Check that the second payment failed to be sent out.
6316         let events = nodes[0].node.get_and_clear_pending_events();
6317         assert_eq!(events.len(), 1);
6318         match &events[0] {
6319                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6320                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6321                         assert_eq!(*rejected_by_dest, false);
6322                         assert_eq!(*error_code, None);
6323                         assert_eq!(*error_data, None);
6324                 },
6325                 _ => panic!("Unexpected event"),
6326         }
6327
6328         // Complete the first payment and the RAA from the fee update.
6329         let (payment_event, send_raa_event) = {
6330                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6331                 assert_eq!(msgs.len(), 2);
6332                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6333         };
6334         let raa = match send_raa_event {
6335                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6336                 _ => panic!("Unexpected event"),
6337         };
6338         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6339         check_added_monitors!(nodes[1], 1);
6340         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6341         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6342         let events = nodes[1].node.get_and_clear_pending_events();
6343         assert_eq!(events.len(), 1);
6344         match events[0] {
6345                 Event::PendingHTLCsForwardable { .. } => {},
6346                 _ => panic!("Unexpected event"),
6347         }
6348         nodes[1].node.process_pending_htlc_forwards();
6349         let events = nodes[1].node.get_and_clear_pending_events();
6350         assert_eq!(events.len(), 1);
6351         match events[0] {
6352                 Event::PaymentReceived { .. } => {},
6353                 _ => panic!("Unexpected event"),
6354         }
6355         nodes[1].node.claim_funds(payment_preimage_1);
6356         check_added_monitors!(nodes[1], 1);
6357         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6358         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6359         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6360         let events = nodes[0].node.get_and_clear_pending_events();
6361         assert_eq!(events.len(), 1);
6362         match events[0] {
6363                 Event::PaymentSent { ref payment_preimage } => {
6364                         assert_eq!(*payment_preimage, payment_preimage_1);
6365                 }
6366                 _ => panic!("Unexpected event"),
6367         }
6368 }
6369
6370 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6371 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6372 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6373 // once it's freed.
6374 #[test]
6375 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6376         let chanmon_cfgs = create_chanmon_cfgs(3);
6377         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6378         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6379         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6380         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6381         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6382         let logger = test_utils::TestLogger::new();
6383
6384         // First nodes[1] generates an update_fee, setting the channel's
6385         // pending_update_fee.
6386         nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6387         check_added_monitors!(nodes[1], 1);
6388
6389         let events = nodes[1].node.get_and_clear_pending_msg_events();
6390         assert_eq!(events.len(), 1);
6391         let (update_msg, commitment_signed) = match events[0] {
6392                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6393                         (update_fee.as_ref(), commitment_signed)
6394                 },
6395                 _ => panic!("Unexpected event"),
6396         };
6397
6398         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6399
6400         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6401         let channel_reserve = chan_stat.channel_reserve_msat;
6402         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6403
6404         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6405         let feemsat = 239;
6406         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6407         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6408         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6409         let payment_event = {
6410                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6411                 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();
6412                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6413                 check_added_monitors!(nodes[0], 1);
6414
6415                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6416                 assert_eq!(events.len(), 1);
6417
6418                 SendEvent::from_event(events.remove(0))
6419         };
6420         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6421         check_added_monitors!(nodes[1], 0);
6422         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6423         expect_pending_htlcs_forwardable!(nodes[1]);
6424
6425         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6426         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6427
6428         // Flush the pending fee update.
6429         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6430         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6431         check_added_monitors!(nodes[2], 1);
6432         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6433         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6434         check_added_monitors!(nodes[1], 2);
6435
6436         // A final RAA message is generated to finalize the fee update.
6437         let events = nodes[1].node.get_and_clear_pending_msg_events();
6438         assert_eq!(events.len(), 1);
6439
6440         let raa_msg = match &events[0] {
6441                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6442                         msg.clone()
6443                 },
6444                 _ => panic!("Unexpected event"),
6445         };
6446
6447         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6448         check_added_monitors!(nodes[2], 1);
6449         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6450
6451         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6452         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6453         assert_eq!(process_htlc_forwards_event.len(), 1);
6454         match &process_htlc_forwards_event[0] {
6455                 &Event::PendingHTLCsForwardable { .. } => {},
6456                 _ => panic!("Unexpected event"),
6457         }
6458
6459         // In response, we call ChannelManager's process_pending_htlc_forwards
6460         nodes[1].node.process_pending_htlc_forwards();
6461         check_added_monitors!(nodes[1], 1);
6462
6463         // This causes the HTLC to be failed backwards.
6464         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6465         assert_eq!(fail_event.len(), 1);
6466         let (fail_msg, commitment_signed) = match &fail_event[0] {
6467                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6468                         assert_eq!(updates.update_add_htlcs.len(), 0);
6469                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6470                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6471                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6472                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6473                 },
6474                 _ => panic!("Unexpected event"),
6475         };
6476
6477         // Pass the failure messages back to nodes[0].
6478         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6479         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6480
6481         // Complete the HTLC failure+removal process.
6482         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6483         check_added_monitors!(nodes[0], 1);
6484         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6485         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6486         check_added_monitors!(nodes[1], 2);
6487         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6488         assert_eq!(final_raa_event.len(), 1);
6489         let raa = match &final_raa_event[0] {
6490                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6491                 _ => panic!("Unexpected event"),
6492         };
6493         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6494         let fail_msg_event = nodes[0].node.get_and_clear_pending_msg_events();
6495         assert_eq!(fail_msg_event.len(), 1);
6496         match &fail_msg_event[0] {
6497                 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
6498                 _ => panic!("Unexpected event"),
6499         }
6500         let failure_event = nodes[0].node.get_and_clear_pending_events();
6501         assert_eq!(failure_event.len(), 1);
6502         match &failure_event[0] {
6503                 &Event::PaymentFailed { rejected_by_dest, .. } => {
6504                         assert!(!rejected_by_dest);
6505                 },
6506                 _ => panic!("Unexpected event"),
6507         }
6508         check_added_monitors!(nodes[0], 1);
6509 }
6510
6511 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6512 // 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.
6513 //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.
6514
6515 #[test]
6516 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6517         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6518         let chanmon_cfgs = create_chanmon_cfgs(2);
6519         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6520         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6521         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6522         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6523
6524         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6525         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6526         let logger = test_utils::TestLogger::new();
6527         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();
6528         route.paths[0][0].fee_msat = 100;
6529
6530         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6531                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6532         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6533         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6534 }
6535
6536 #[test]
6537 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6538         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6539         let chanmon_cfgs = create_chanmon_cfgs(2);
6540         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6541         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6542         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6543         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6544         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6545
6546         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6547         let logger = test_utils::TestLogger::new();
6548         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();
6549         route.paths[0][0].fee_msat = 0;
6550         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6551                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6552
6553         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6554         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6555 }
6556
6557 #[test]
6558 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6559         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6560         let chanmon_cfgs = create_chanmon_cfgs(2);
6561         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6562         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6563         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6564         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6565
6566         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6567         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6568         let logger = test_utils::TestLogger::new();
6569         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();
6570         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6571         check_added_monitors!(nodes[0], 1);
6572         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6573         updates.update_add_htlcs[0].amount_msat = 0;
6574
6575         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6576         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6577         check_closed_broadcast!(nodes[1], true).unwrap();
6578         check_added_monitors!(nodes[1], 1);
6579 }
6580
6581 #[test]
6582 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6583         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6584         //It is enforced when constructing a route.
6585         let chanmon_cfgs = create_chanmon_cfgs(2);
6586         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6587         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6588         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6589         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6590         let logger = test_utils::TestLogger::new();
6591
6592         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6593
6594         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6595         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();
6596         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6597                 assert_eq!(err, &"Channel CLTV overflowed?"));
6598 }
6599
6600 #[test]
6601 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6602         //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.
6603         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6604         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6605         let chanmon_cfgs = create_chanmon_cfgs(2);
6606         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6607         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6608         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6609         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6610         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6611
6612         let logger = test_utils::TestLogger::new();
6613         for i in 0..max_accepted_htlcs {
6614                 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6615                 let payment_event = {
6616                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6617                         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();
6618                         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6619                         check_added_monitors!(nodes[0], 1);
6620
6621                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6622                         assert_eq!(events.len(), 1);
6623                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6624                                 assert_eq!(htlcs[0].htlc_id, i);
6625                         } else {
6626                                 assert!(false);
6627                         }
6628                         SendEvent::from_event(events.remove(0))
6629                 };
6630                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6631                 check_added_monitors!(nodes[1], 0);
6632                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6633
6634                 expect_pending_htlcs_forwardable!(nodes[1]);
6635                 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6636         }
6637         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6638         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6639         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();
6640         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6641                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6642
6643         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6644         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6645 }
6646
6647 #[test]
6648 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6649         //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.
6650         let chanmon_cfgs = create_chanmon_cfgs(2);
6651         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6652         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6653         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6654         let channel_value = 100000;
6655         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6656         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6657
6658         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6659
6660         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6661         // Manually create a route over our max in flight (which our router normally automatically
6662         // limits us to.
6663         let route = Route { paths: vec![vec![RouteHop {
6664            pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6665            short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6666            fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6667         }]] };
6668         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6669                 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)));
6670
6671         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6672         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);
6673
6674         send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6675 }
6676
6677 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6678 #[test]
6679 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6680         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6681         let chanmon_cfgs = create_chanmon_cfgs(2);
6682         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6683         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6684         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6685         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6686         let htlc_minimum_msat: u64;
6687         {
6688                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6689                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6690                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6691         }
6692
6693         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6694         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6695         let logger = test_utils::TestLogger::new();
6696         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();
6697         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6698         check_added_monitors!(nodes[0], 1);
6699         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6700         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6701         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6702         assert!(nodes[1].node.list_channels().is_empty());
6703         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6704         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()));
6705         check_added_monitors!(nodes[1], 1);
6706 }
6707
6708 #[test]
6709 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6710         //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
6711         let chanmon_cfgs = create_chanmon_cfgs(2);
6712         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6713         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6714         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6715         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6716         let logger = test_utils::TestLogger::new();
6717
6718         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6719         let channel_reserve = chan_stat.channel_reserve_msat;
6720         let feerate = get_feerate!(nodes[0], chan.2);
6721         // The 2* and +1 are for the fee spike reserve.
6722         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6723
6724         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6725         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6726         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6727         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();
6728         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6729         check_added_monitors!(nodes[0], 1);
6730         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6731
6732         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6733         // at this time channel-initiatee receivers are not required to enforce that senders
6734         // respect the fee_spike_reserve.
6735         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6736         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6737
6738         assert!(nodes[1].node.list_channels().is_empty());
6739         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6740         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6741         check_added_monitors!(nodes[1], 1);
6742 }
6743
6744 #[test]
6745 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6746         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6747         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6748         let chanmon_cfgs = create_chanmon_cfgs(2);
6749         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6750         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6751         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6752         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6753         let logger = test_utils::TestLogger::new();
6754
6755         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6756         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6757
6758         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6759         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();
6760
6761         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6762         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6763         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height).unwrap();
6764         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6765
6766         let mut msg = msgs::UpdateAddHTLC {
6767                 channel_id: chan.2,
6768                 htlc_id: 0,
6769                 amount_msat: 1000,
6770                 payment_hash: our_payment_hash,
6771                 cltv_expiry: htlc_cltv,
6772                 onion_routing_packet: onion_packet.clone(),
6773         };
6774
6775         for i in 0..super::channel::OUR_MAX_HTLCS {
6776                 msg.htlc_id = i as u64;
6777                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6778         }
6779         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6780         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6781
6782         assert!(nodes[1].node.list_channels().is_empty());
6783         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6784         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6785         check_added_monitors!(nodes[1], 1);
6786 }
6787
6788 #[test]
6789 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6790         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6791         let chanmon_cfgs = create_chanmon_cfgs(2);
6792         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6793         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6794         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6795         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6796         let logger = test_utils::TestLogger::new();
6797
6798         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6799         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6800         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();
6801         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6802         check_added_monitors!(nodes[0], 1);
6803         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6804         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6805         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6806
6807         assert!(nodes[1].node.list_channels().is_empty());
6808         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6809         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6810         check_added_monitors!(nodes[1], 1);
6811 }
6812
6813 #[test]
6814 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6815         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6816         let chanmon_cfgs = create_chanmon_cfgs(2);
6817         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6818         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6819         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6820         let logger = test_utils::TestLogger::new();
6821
6822         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6823         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6824         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6825         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();
6826         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6827         check_added_monitors!(nodes[0], 1);
6828         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6829         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6830         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6831
6832         assert!(nodes[1].node.list_channels().is_empty());
6833         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6834         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6835         check_added_monitors!(nodes[1], 1);
6836 }
6837
6838 #[test]
6839 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6840         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6841         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6842         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6843         let chanmon_cfgs = create_chanmon_cfgs(2);
6844         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6845         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6846         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6847         let logger = test_utils::TestLogger::new();
6848
6849         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6850         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6851         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6852         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();
6853         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6854         check_added_monitors!(nodes[0], 1);
6855         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6856         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6857
6858         //Disconnect and Reconnect
6859         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6860         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6861         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6862         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6863         assert_eq!(reestablish_1.len(), 1);
6864         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6865         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6866         assert_eq!(reestablish_2.len(), 1);
6867         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6868         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6869         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6870         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6871
6872         //Resend HTLC
6873         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6874         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6875         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6876         check_added_monitors!(nodes[1], 1);
6877         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6878
6879         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6880
6881         assert!(nodes[1].node.list_channels().is_empty());
6882         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6883         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6884         check_added_monitors!(nodes[1], 1);
6885 }
6886
6887 #[test]
6888 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6889         //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.
6890
6891         let chanmon_cfgs = create_chanmon_cfgs(2);
6892         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6893         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6894         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6895         let logger = test_utils::TestLogger::new();
6896         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6897         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6898         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6899         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6900         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6901
6902         check_added_monitors!(nodes[0], 1);
6903         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6904         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6905
6906         let update_msg = msgs::UpdateFulfillHTLC{
6907                 channel_id: chan.2,
6908                 htlc_id: 0,
6909                 payment_preimage: our_payment_preimage,
6910         };
6911
6912         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6913
6914         assert!(nodes[0].node.list_channels().is_empty());
6915         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6916         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()));
6917         check_added_monitors!(nodes[0], 1);
6918 }
6919
6920 #[test]
6921 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6922         //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.
6923
6924         let chanmon_cfgs = create_chanmon_cfgs(2);
6925         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6926         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6927         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6928         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6929         let logger = test_utils::TestLogger::new();
6930
6931         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6932         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6933         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();
6934         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6935         check_added_monitors!(nodes[0], 1);
6936         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6937         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6938
6939         let update_msg = msgs::UpdateFailHTLC{
6940                 channel_id: chan.2,
6941                 htlc_id: 0,
6942                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6943         };
6944
6945         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6946
6947         assert!(nodes[0].node.list_channels().is_empty());
6948         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6949         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()));
6950         check_added_monitors!(nodes[0], 1);
6951 }
6952
6953 #[test]
6954 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6955         //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.
6956
6957         let chanmon_cfgs = create_chanmon_cfgs(2);
6958         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6959         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6960         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6961         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6962         let logger = test_utils::TestLogger::new();
6963
6964         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6965         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6966         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();
6967         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6968         check_added_monitors!(nodes[0], 1);
6969         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6970         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6971         let update_msg = msgs::UpdateFailMalformedHTLC{
6972                 channel_id: chan.2,
6973                 htlc_id: 0,
6974                 sha256_of_onion: [1; 32],
6975                 failure_code: 0x8000,
6976         };
6977
6978         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6979
6980         assert!(nodes[0].node.list_channels().is_empty());
6981         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6982         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()));
6983         check_added_monitors!(nodes[0], 1);
6984 }
6985
6986 #[test]
6987 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6988         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6989
6990         let chanmon_cfgs = create_chanmon_cfgs(2);
6991         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6992         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6993         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6994         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6995
6996         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6997
6998         nodes[1].node.claim_funds(our_payment_preimage);
6999         check_added_monitors!(nodes[1], 1);
7000
7001         let events = nodes[1].node.get_and_clear_pending_msg_events();
7002         assert_eq!(events.len(), 1);
7003         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7004                 match events[0] {
7005                         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, .. } } => {
7006                                 assert!(update_add_htlcs.is_empty());
7007                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7008                                 assert!(update_fail_htlcs.is_empty());
7009                                 assert!(update_fail_malformed_htlcs.is_empty());
7010                                 assert!(update_fee.is_none());
7011                                 update_fulfill_htlcs[0].clone()
7012                         },
7013                         _ => panic!("Unexpected event"),
7014                 }
7015         };
7016
7017         update_fulfill_msg.htlc_id = 1;
7018
7019         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7020
7021         assert!(nodes[0].node.list_channels().is_empty());
7022         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7023         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
7024         check_added_monitors!(nodes[0], 1);
7025 }
7026
7027 #[test]
7028 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
7029         //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.
7030
7031         let chanmon_cfgs = create_chanmon_cfgs(2);
7032         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7033         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7034         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7035         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7036
7037         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7038
7039         nodes[1].node.claim_funds(our_payment_preimage);
7040         check_added_monitors!(nodes[1], 1);
7041
7042         let events = nodes[1].node.get_and_clear_pending_msg_events();
7043         assert_eq!(events.len(), 1);
7044         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7045                 match events[0] {
7046                         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, .. } } => {
7047                                 assert!(update_add_htlcs.is_empty());
7048                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7049                                 assert!(update_fail_htlcs.is_empty());
7050                                 assert!(update_fail_malformed_htlcs.is_empty());
7051                                 assert!(update_fee.is_none());
7052                                 update_fulfill_htlcs[0].clone()
7053                         },
7054                         _ => panic!("Unexpected event"),
7055                 }
7056         };
7057
7058         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
7059
7060         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7061
7062         assert!(nodes[0].node.list_channels().is_empty());
7063         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7064         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
7065         check_added_monitors!(nodes[0], 1);
7066 }
7067
7068 #[test]
7069 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
7070         //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.
7071
7072         let chanmon_cfgs = create_chanmon_cfgs(2);
7073         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7074         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7075         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7076         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7077         let logger = test_utils::TestLogger::new();
7078
7079         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7080         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7081         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();
7082         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7083         check_added_monitors!(nodes[0], 1);
7084
7085         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7086         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7087
7088         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7089         check_added_monitors!(nodes[1], 0);
7090         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7091
7092         let events = nodes[1].node.get_and_clear_pending_msg_events();
7093
7094         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7095                 match events[0] {
7096                         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, .. } } => {
7097                                 assert!(update_add_htlcs.is_empty());
7098                                 assert!(update_fulfill_htlcs.is_empty());
7099                                 assert!(update_fail_htlcs.is_empty());
7100                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7101                                 assert!(update_fee.is_none());
7102                                 update_fail_malformed_htlcs[0].clone()
7103                         },
7104                         _ => panic!("Unexpected event"),
7105                 }
7106         };
7107         update_msg.failure_code &= !0x8000;
7108         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7109
7110         assert!(nodes[0].node.list_channels().is_empty());
7111         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7112         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7113         check_added_monitors!(nodes[0], 1);
7114 }
7115
7116 #[test]
7117 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7118         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7119         //    * 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.
7120
7121         let chanmon_cfgs = create_chanmon_cfgs(3);
7122         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7123         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7124         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7125         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7126         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7127         let logger = test_utils::TestLogger::new();
7128
7129         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7130
7131         //First hop
7132         let mut payment_event = {
7133                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7134                 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();
7135                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7136                 check_added_monitors!(nodes[0], 1);
7137                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7138                 assert_eq!(events.len(), 1);
7139                 SendEvent::from_event(events.remove(0))
7140         };
7141         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7142         check_added_monitors!(nodes[1], 0);
7143         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7144         expect_pending_htlcs_forwardable!(nodes[1]);
7145         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7146         assert_eq!(events_2.len(), 1);
7147         check_added_monitors!(nodes[1], 1);
7148         payment_event = SendEvent::from_event(events_2.remove(0));
7149         assert_eq!(payment_event.msgs.len(), 1);
7150
7151         //Second Hop
7152         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7153         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7154         check_added_monitors!(nodes[2], 0);
7155         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7156
7157         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7158         assert_eq!(events_3.len(), 1);
7159         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7160                 match events_3[0] {
7161                         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 } } => {
7162                                 assert!(update_add_htlcs.is_empty());
7163                                 assert!(update_fulfill_htlcs.is_empty());
7164                                 assert!(update_fail_htlcs.is_empty());
7165                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7166                                 assert!(update_fee.is_none());
7167                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7168                         },
7169                         _ => panic!("Unexpected event"),
7170                 }
7171         };
7172
7173         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7174
7175         check_added_monitors!(nodes[1], 0);
7176         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7177         expect_pending_htlcs_forwardable!(nodes[1]);
7178         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7179         assert_eq!(events_4.len(), 1);
7180
7181         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7182         match events_4[0] {
7183                 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, .. } } => {
7184                         assert!(update_add_htlcs.is_empty());
7185                         assert!(update_fulfill_htlcs.is_empty());
7186                         assert_eq!(update_fail_htlcs.len(), 1);
7187                         assert!(update_fail_malformed_htlcs.is_empty());
7188                         assert!(update_fee.is_none());
7189                 },
7190                 _ => panic!("Unexpected event"),
7191         };
7192
7193         check_added_monitors!(nodes[1], 1);
7194 }
7195
7196 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7197         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7198         // 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
7199         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7200
7201         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7202         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7203         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7204         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7205         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7206         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7207
7208         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7209
7210         // We route 2 dust-HTLCs between A and B
7211         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7212         let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7213         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7214
7215         // Cache one local commitment tx as previous
7216         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7217
7218         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7219         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7220         check_added_monitors!(nodes[1], 0);
7221         expect_pending_htlcs_forwardable!(nodes[1]);
7222         check_added_monitors!(nodes[1], 1);
7223
7224         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7225         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7226         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7227         check_added_monitors!(nodes[0], 1);
7228
7229         // Cache one local commitment tx as lastest
7230         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7231
7232         let events = nodes[0].node.get_and_clear_pending_msg_events();
7233         match events[0] {
7234                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7235                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7236                 },
7237                 _ => panic!("Unexpected event"),
7238         }
7239         match events[1] {
7240                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7241                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7242                 },
7243                 _ => panic!("Unexpected event"),
7244         }
7245
7246         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7247         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7248         if announce_latest {
7249                 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7250         } else {
7251                 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7252         }
7253
7254         check_closed_broadcast!(nodes[0], true);
7255         check_added_monitors!(nodes[0], 1);
7256
7257         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7258         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7259         let events = nodes[0].node.get_and_clear_pending_events();
7260         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7261         assert_eq!(events.len(), 2);
7262         let mut first_failed = false;
7263         for event in events {
7264                 match event {
7265                         Event::PaymentFailed { payment_hash, .. } => {
7266                                 if payment_hash == payment_hash_1 {
7267                                         assert!(!first_failed);
7268                                         first_failed = true;
7269                                 } else {
7270                                         assert_eq!(payment_hash, payment_hash_2);
7271                                 }
7272                         }
7273                         _ => panic!("Unexpected event"),
7274                 }
7275         }
7276 }
7277
7278 #[test]
7279 fn test_failure_delay_dust_htlc_local_commitment() {
7280         do_test_failure_delay_dust_htlc_local_commitment(true);
7281         do_test_failure_delay_dust_htlc_local_commitment(false);
7282 }
7283
7284 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7285         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7286         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7287         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7288         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7289         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7290         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7291
7292         let chanmon_cfgs = create_chanmon_cfgs(3);
7293         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7294         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7295         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7296         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7297
7298         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7299
7300         let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7301         let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7302
7303         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7304         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7305
7306         // We revoked bs_commitment_tx
7307         if revoked {
7308                 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7309                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7310         }
7311
7312         let mut timeout_tx = Vec::new();
7313         if local {
7314                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7315                 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7316                 check_closed_broadcast!(nodes[0], true);
7317                 check_added_monitors!(nodes[0], 1);
7318                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7319                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7320                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7321                 expect_payment_failed!(nodes[0], dust_hash, true);
7322                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7323                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7324                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7325                 mine_transaction(&nodes[0], &timeout_tx[0]);
7326                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7327                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7328         } else {
7329                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7330                 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7331                 check_closed_broadcast!(nodes[0], true);
7332                 check_added_monitors!(nodes[0], 1);
7333                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7334                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7335                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[2].clone());
7336                 if !revoked {
7337                         expect_payment_failed!(nodes[0], dust_hash, true);
7338                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7339                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7340                         mine_transaction(&nodes[0], &timeout_tx[0]);
7341                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7342                         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7343                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7344                 } else {
7345                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7346                         // commitment tx
7347                         let events = nodes[0].node.get_and_clear_pending_events();
7348                         assert_eq!(events.len(), 2);
7349                         let first;
7350                         match events[0] {
7351                                 Event::PaymentFailed { payment_hash, .. } => {
7352                                         if payment_hash == dust_hash { first = true; }
7353                                         else { first = false; }
7354                                 },
7355                                 _ => panic!("Unexpected event"),
7356                         }
7357                         match events[1] {
7358                                 Event::PaymentFailed { payment_hash, .. } => {
7359                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7360                                         else { assert_eq!(payment_hash, dust_hash); }
7361                                 },
7362                                 _ => panic!("Unexpected event"),
7363                         }
7364                 }
7365         }
7366 }
7367
7368 #[test]
7369 fn test_sweep_outbound_htlc_failure_update() {
7370         do_test_sweep_outbound_htlc_failure_update(false, true);
7371         do_test_sweep_outbound_htlc_failure_update(false, false);
7372         do_test_sweep_outbound_htlc_failure_update(true, false);
7373 }
7374
7375 #[test]
7376 fn test_upfront_shutdown_script() {
7377         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7378         // enforce it at shutdown message
7379
7380         let mut config = UserConfig::default();
7381         config.channel_options.announced_channel = true;
7382         config.peer_channel_config_limits.force_announced_channel_preference = false;
7383         config.channel_options.commit_upfront_shutdown_pubkey = false;
7384         let user_cfgs = [None, Some(config), None];
7385         let chanmon_cfgs = create_chanmon_cfgs(3);
7386         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7387         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7388         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7389
7390         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7391         let flags = InitFeatures::known();
7392         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7393         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7394         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7395         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7396         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7397         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7398     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()));
7399         check_added_monitors!(nodes[2], 1);
7400
7401         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7402         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7403         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7404         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7405         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7406         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7407         let events = nodes[2].node.get_and_clear_pending_msg_events();
7408         assert_eq!(events.len(), 1);
7409         match events[0] {
7410                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7411                 _ => panic!("Unexpected event"),
7412         }
7413
7414         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7415         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7416         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7417         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7418         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7419         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7420         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7421         let events = nodes[1].node.get_and_clear_pending_msg_events();
7422         assert_eq!(events.len(), 1);
7423         match events[0] {
7424                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7425                 _ => panic!("Unexpected event"),
7426         }
7427
7428         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7429         // channel smoothly, opt-out is from channel initiator here
7430         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7431         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7432         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7433         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7434         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7435         let events = nodes[0].node.get_and_clear_pending_msg_events();
7436         assert_eq!(events.len(), 1);
7437         match events[0] {
7438                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7439                 _ => panic!("Unexpected event"),
7440         }
7441
7442         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7443         //// channel smoothly
7444         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7445         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7446         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7447         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7448         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7449         let events = nodes[0].node.get_and_clear_pending_msg_events();
7450         assert_eq!(events.len(), 2);
7451         match events[0] {
7452                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7453                 _ => panic!("Unexpected event"),
7454         }
7455         match events[1] {
7456                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7457                 _ => panic!("Unexpected event"),
7458         }
7459 }
7460
7461 #[test]
7462 fn test_upfront_shutdown_script_unsupport_segwit() {
7463         // We test that channel is closed early
7464         // if a segwit program is passed as upfront shutdown script,
7465         // but the peer does not support segwit.
7466         let chanmon_cfgs = create_chanmon_cfgs(2);
7467         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7468         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7469         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7470
7471         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7472
7473         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7474         open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(16)
7475                 .push_slice(&[0, 0])
7476                 .into_script());
7477
7478         let features = InitFeatures::known().clear_shutdown_anysegwit();
7479         nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), features, &open_channel);
7480
7481         let events = nodes[0].node.get_and_clear_pending_msg_events();
7482         assert_eq!(events.len(), 1);
7483         match events[0] {
7484                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7485                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
7486                         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));
7487                 },
7488                 _ => panic!("Unexpected event"),
7489         }
7490 }
7491
7492 #[test]
7493 fn test_shutdown_script_any_segwit_allowed() {
7494         let mut config = UserConfig::default();
7495         config.channel_options.announced_channel = true;
7496         config.peer_channel_config_limits.force_announced_channel_preference = false;
7497         config.channel_options.commit_upfront_shutdown_pubkey = false;
7498         let user_cfgs = [None, Some(config), None];
7499         let chanmon_cfgs = create_chanmon_cfgs(3);
7500         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7501         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7502         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7503
7504         //// We test if the remote peer accepts opt_shutdown_anysegwit, a witness program can be used on shutdown
7505         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7506         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7507         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7508         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7509                 .push_slice(&[0, 0])
7510                 .into_script();
7511         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7512         let events = nodes[0].node.get_and_clear_pending_msg_events();
7513         assert_eq!(events.len(), 2);
7514         match events[0] {
7515                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7516                 _ => panic!("Unexpected event"),
7517         }
7518         match events[1] {
7519                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7520                 _ => panic!("Unexpected event"),
7521         }
7522 }
7523
7524 #[test]
7525 fn test_shutdown_script_any_segwit_not_allowed() {
7526         let mut config = UserConfig::default();
7527         config.channel_options.announced_channel = true;
7528         config.peer_channel_config_limits.force_announced_channel_preference = false;
7529         config.channel_options.commit_upfront_shutdown_pubkey = false;
7530         let user_cfgs = [None, Some(config), None];
7531         let chanmon_cfgs = create_chanmon_cfgs(3);
7532         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7533         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7534         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7535
7536         //// We test that if the remote peer does not accept opt_shutdown_anysegwit, the witness program cannot be used on shutdown
7537         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7538         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7539         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7540         // Make an any segwit version script
7541         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7542                 .push_slice(&[0, 0])
7543                 .into_script();
7544         let flags_no = InitFeatures::known().clear_shutdown_anysegwit();
7545         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &flags_no, &node_0_shutdown);
7546         let events = nodes[0].node.get_and_clear_pending_msg_events();
7547         assert_eq!(events.len(), 2);
7548         match events[1] {
7549                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7550                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7551                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020000) from remote peer".to_owned())
7552                 },
7553                 _ => panic!("Unexpected event"),
7554         }
7555         check_added_monitors!(nodes[0], 1);
7556 }
7557
7558 #[test]
7559 fn test_shutdown_script_segwit_but_not_anysegwit() {
7560         let mut config = UserConfig::default();
7561         config.channel_options.announced_channel = true;
7562         config.peer_channel_config_limits.force_announced_channel_preference = false;
7563         config.channel_options.commit_upfront_shutdown_pubkey = false;
7564         let user_cfgs = [None, Some(config), None];
7565         let chanmon_cfgs = create_chanmon_cfgs(3);
7566         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7567         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7568         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7569
7570         //// We test that if shutdown any segwit is supported and we send a witness script with 0 version, this is not accepted
7571         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7572         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7573         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7574         // Make a segwit script that is not a valid as any segwit
7575         node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7576                 .push_slice(&[0, 0])
7577                 .into_script();
7578         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7579         let events = nodes[0].node.get_and_clear_pending_msg_events();
7580         assert_eq!(events.len(), 2);
7581         match events[1] {
7582                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7583                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7584                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7585                 },
7586                 _ => panic!("Unexpected event"),
7587         }
7588         check_added_monitors!(nodes[0], 1);
7589 }
7590
7591 #[test]
7592 fn test_user_configurable_csv_delay() {
7593         // We test our channel constructors yield errors when we pass them absurd csv delay
7594
7595         let mut low_our_to_self_config = UserConfig::default();
7596         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7597         let mut high_their_to_self_config = UserConfig::default();
7598         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7599         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7600         let chanmon_cfgs = create_chanmon_cfgs(2);
7601         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7602         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7603         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7604
7605         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7606         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) {
7607                 match error {
7608                         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())); },
7609                         _ => panic!("Unexpected event"),
7610                 }
7611         } else { assert!(false) }
7612
7613         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7614         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7615         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7616         open_channel.to_self_delay = 200;
7617         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) {
7618                 match error {
7619                         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()));  },
7620                         _ => panic!("Unexpected event"),
7621                 }
7622         } else { assert!(false); }
7623
7624         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7625         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7626         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()));
7627         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7628         accept_channel.to_self_delay = 200;
7629         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7630         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7631                 match action {
7632                         &ErrorAction::SendErrorMessage { ref msg } => {
7633                                 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()));
7634                         },
7635                         _ => { assert!(false); }
7636                 }
7637         } else { assert!(false); }
7638
7639         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7640         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7641         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7642         open_channel.to_self_delay = 200;
7643         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) {
7644                 match error {
7645                         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())); },
7646                         _ => panic!("Unexpected event"),
7647                 }
7648         } else { assert!(false); }
7649 }
7650
7651 #[test]
7652 fn test_data_loss_protect() {
7653         // We want to be sure that :
7654         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7655         //   (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7656         // * we close channel in case of detecting other being fallen behind
7657         // * we are able to claim our own outputs thanks to to_remote being static
7658         // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7659         let persister;
7660         let logger;
7661         let fee_estimator;
7662         let tx_broadcaster;
7663         let chain_source;
7664         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7665         // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7666         // during signing due to revoked tx
7667         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7668         let keys_manager = &chanmon_cfgs[0].keys_manager;
7669         let monitor;
7670         let node_state_0;
7671         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7672         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7673         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7674
7675         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7676
7677         // Cache node A state before any channel update
7678         let previous_node_state = nodes[0].node.encode();
7679         let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7680         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7681
7682         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7683         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7684
7685         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7686         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7687
7688         // Restore node A from previous state
7689         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7690         let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7691         chain_source = test_utils::TestChainSource::new(Network::Testnet);
7692         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7693         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7694         persister = test_utils::TestPersister::new();
7695         monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7696         node_state_0 = {
7697                 let mut channel_monitors = HashMap::new();
7698                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7699                 <(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 {
7700                         keys_manager: keys_manager,
7701                         fee_estimator: &fee_estimator,
7702                         chain_monitor: &monitor,
7703                         logger: &logger,
7704                         tx_broadcaster: &tx_broadcaster,
7705                         default_config: UserConfig::default(),
7706                         channel_monitors,
7707                 }).unwrap().1
7708         };
7709         nodes[0].node = &node_state_0;
7710         assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7711         nodes[0].chain_monitor = &monitor;
7712         nodes[0].chain_source = &chain_source;
7713
7714         check_added_monitors!(nodes[0], 1);
7715
7716         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7717         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7718
7719         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7720
7721         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7722         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7723         check_added_monitors!(nodes[0], 1);
7724
7725         {
7726                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7727                 assert_eq!(node_txn.len(), 0);
7728         }
7729
7730         let mut reestablish_1 = Vec::with_capacity(1);
7731         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7732                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7733                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7734                         reestablish_1.push(msg.clone());
7735                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7736                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7737                         match action {
7738                                 &ErrorAction::SendErrorMessage { ref msg } => {
7739                                         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");
7740                                 },
7741                                 _ => panic!("Unexpected event!"),
7742                         }
7743                 } else {
7744                         panic!("Unexpected event")
7745                 }
7746         }
7747
7748         // Check we close channel detecting A is fallen-behind
7749         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7750         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7751         check_added_monitors!(nodes[1], 1);
7752
7753
7754         // Check A is able to claim to_remote output
7755         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7756         assert_eq!(node_txn.len(), 1);
7757         check_spends!(node_txn[0], chan.3);
7758         assert_eq!(node_txn[0].output.len(), 2);
7759         mine_transaction(&nodes[0], &node_txn[0]);
7760         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7761         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 1000000);
7762         assert_eq!(spend_txn.len(), 1);
7763         check_spends!(spend_txn[0], node_txn[0]);
7764 }
7765
7766 #[test]
7767 fn test_check_htlc_underpaying() {
7768         // Send payment through A -> B but A is maliciously
7769         // sending a probe payment (i.e less than expected value0
7770         // to B, B should refuse payment.
7771
7772         let chanmon_cfgs = create_chanmon_cfgs(2);
7773         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7774         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7775         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7776
7777         // Create some initial channels
7778         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7779
7780         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();
7781         let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7782         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7783         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7784         check_added_monitors!(nodes[0], 1);
7785
7786         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7787         assert_eq!(events.len(), 1);
7788         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7789         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7790         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7791
7792         // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7793         // and then will wait a second random delay before failing the HTLC back:
7794         expect_pending_htlcs_forwardable!(nodes[1]);
7795         expect_pending_htlcs_forwardable!(nodes[1]);
7796
7797         // Node 3 is expecting payment of 100_000 but received 10_000,
7798         // it should fail htlc like we didn't know the preimage.
7799         nodes[1].node.process_pending_htlc_forwards();
7800
7801         let events = nodes[1].node.get_and_clear_pending_msg_events();
7802         assert_eq!(events.len(), 1);
7803         let (update_fail_htlc, commitment_signed) = match events[0] {
7804                 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 } } => {
7805                         assert!(update_add_htlcs.is_empty());
7806                         assert!(update_fulfill_htlcs.is_empty());
7807                         assert_eq!(update_fail_htlcs.len(), 1);
7808                         assert!(update_fail_malformed_htlcs.is_empty());
7809                         assert!(update_fee.is_none());
7810                         (update_fail_htlcs[0].clone(), commitment_signed)
7811                 },
7812                 _ => panic!("Unexpected event"),
7813         };
7814         check_added_monitors!(nodes[1], 1);
7815
7816         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7817         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7818
7819         // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7820         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7821         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7822         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7823 }
7824
7825 #[test]
7826 fn test_announce_disable_channels() {
7827         // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7828         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7829
7830         let chanmon_cfgs = create_chanmon_cfgs(2);
7831         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7832         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7833         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7834
7835         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7836         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7837         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7838
7839         // Disconnect peers
7840         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7841         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7842
7843         nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7844         nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7845         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7846         assert_eq!(msg_events.len(), 3);
7847         let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7848         for e in msg_events {
7849                 match e {
7850                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7851                                 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7852                                 // Check that each channel gets updated exactly once
7853                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7854                                         panic!("Generated ChannelUpdate for wrong chan!");
7855                                 }
7856                         },
7857                         _ => panic!("Unexpected event"),
7858                 }
7859         }
7860         // Reconnect peers
7861         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7862         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7863         assert_eq!(reestablish_1.len(), 3);
7864         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7865         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7866         assert_eq!(reestablish_2.len(), 3);
7867
7868         // Reestablish chan_1
7869         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
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[0]);
7872         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7873         // Reestablish chan_2
7874         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
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[1]);
7877         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7878         // Reestablish chan_3
7879         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7880         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7881         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7882         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7883
7884         nodes[0].node.timer_tick_occurred();
7885         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7886         nodes[0].node.timer_tick_occurred();
7887         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7888         assert_eq!(msg_events.len(), 3);
7889         chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7890         for e in msg_events {
7891                 match e {
7892                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7893                                 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7894                                 // Check that each channel gets updated exactly once
7895                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7896                                         panic!("Generated ChannelUpdate for wrong chan!");
7897                                 }
7898                         },
7899                         _ => panic!("Unexpected event"),
7900                 }
7901         }
7902 }
7903
7904 #[test]
7905 fn test_bump_penalty_txn_on_revoked_commitment() {
7906         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7907         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7908
7909         let chanmon_cfgs = create_chanmon_cfgs(2);
7910         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7911         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7912         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7913
7914         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7915         let logger = test_utils::TestLogger::new();
7916
7917         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7918         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7919         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();
7920         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7921
7922         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7923         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7924         assert_eq!(revoked_txn[0].output.len(), 4);
7925         assert_eq!(revoked_txn[0].input.len(), 1);
7926         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7927         let revoked_txid = revoked_txn[0].txid();
7928
7929         let mut penalty_sum = 0;
7930         for outp in revoked_txn[0].output.iter() {
7931                 if outp.script_pubkey.is_v0_p2wsh() {
7932                         penalty_sum += outp.value;
7933                 }
7934         }
7935
7936         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7937         let header_114 = connect_blocks(&nodes[1], 14);
7938
7939         // Actually revoke tx by claiming a HTLC
7940         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7941         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7942         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7943         check_added_monitors!(nodes[1], 1);
7944
7945         // One or more justice tx should have been broadcast, check it
7946         let penalty_1;
7947         let feerate_1;
7948         {
7949                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7950                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7951                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7952                 assert_eq!(node_txn[0].output.len(), 1);
7953                 check_spends!(node_txn[0], revoked_txn[0]);
7954                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7955                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7956                 penalty_1 = node_txn[0].txid();
7957                 node_txn.clear();
7958         };
7959
7960         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7961         connect_blocks(&nodes[1], 15);
7962         let mut penalty_2 = penalty_1;
7963         let mut feerate_2 = 0;
7964         {
7965                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7966                 assert_eq!(node_txn.len(), 1);
7967                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7968                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7969                         assert_eq!(node_txn[0].output.len(), 1);
7970                         check_spends!(node_txn[0], revoked_txn[0]);
7971                         penalty_2 = node_txn[0].txid();
7972                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7973                         assert_ne!(penalty_2, penalty_1);
7974                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7975                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7976                         // Verify 25% bump heuristic
7977                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7978                         node_txn.clear();
7979                 }
7980         }
7981         assert_ne!(feerate_2, 0);
7982
7983         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7984         connect_blocks(&nodes[1], 1);
7985         let penalty_3;
7986         let mut feerate_3 = 0;
7987         {
7988                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7989                 assert_eq!(node_txn.len(), 1);
7990                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7991                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7992                         assert_eq!(node_txn[0].output.len(), 1);
7993                         check_spends!(node_txn[0], revoked_txn[0]);
7994                         penalty_3 = node_txn[0].txid();
7995                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7996                         assert_ne!(penalty_3, penalty_2);
7997                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7998                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7999                         // Verify 25% bump heuristic
8000                         assert!(feerate_3 * 100 >= feerate_2 * 125);
8001                         node_txn.clear();
8002                 }
8003         }
8004         assert_ne!(feerate_3, 0);
8005
8006         nodes[1].node.get_and_clear_pending_events();
8007         nodes[1].node.get_and_clear_pending_msg_events();
8008 }
8009
8010 #[test]
8011 fn test_bump_penalty_txn_on_revoked_htlcs() {
8012         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
8013         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
8014
8015         let mut chanmon_cfgs = create_chanmon_cfgs(2);
8016         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
8017         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8018         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8019         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8020
8021         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8022         // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
8023         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
8024                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8025         let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
8026         let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph.read().unwrap(),
8027                 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8028         send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
8029
8030         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8031         assert_eq!(revoked_local_txn[0].input.len(), 1);
8032         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8033
8034         // Revoke local commitment tx
8035         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8036
8037         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8038         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
8039         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
8040         check_closed_broadcast!(nodes[1], true);
8041         check_added_monitors!(nodes[1], 1);
8042         connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
8043
8044         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8045         assert_eq!(revoked_htlc_txn.len(), 4);
8046         check_spends!(revoked_htlc_txn[1], chan.3);
8047         check_spends!(revoked_htlc_txn[2], revoked_htlc_txn[1]);
8048
8049         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
8050         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8051         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8052
8053         assert_eq!(revoked_htlc_txn[3].input.len(), 1);
8054         assert_eq!(revoked_htlc_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8055         assert_eq!(revoked_htlc_txn[3].output.len(), 1);
8056         check_spends!(revoked_htlc_txn[3], revoked_local_txn[0]);
8057
8058         // Broadcast set of revoked txn on A
8059         let hash_128 = connect_blocks(&nodes[0], 40);
8060         let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8061         connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
8062         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8063         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[3].clone()] });
8064         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8065         let first;
8066         let feerate_1;
8067         let penalty_txn;
8068         {
8069                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8070                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
8071                 // Verify claim tx are spending revoked HTLC txn
8072
8073                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
8074                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
8075                 // which are included in the same block (they are broadcasted because we scan the
8076                 // transactions linearly and generate claims as we go, they likely should be removed in the
8077                 // future).
8078                 assert_eq!(node_txn[0].input.len(), 1);
8079                 check_spends!(node_txn[0], revoked_local_txn[0]);
8080                 assert_eq!(node_txn[1].input.len(), 1);
8081                 check_spends!(node_txn[1], revoked_local_txn[0]);
8082                 assert_eq!(node_txn[2].input.len(), 1);
8083                 check_spends!(node_txn[2], revoked_local_txn[0]);
8084
8085                 // Each of the three justice transactions claim a separate (single) output of the three
8086                 // available, which we check here:
8087                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
8088                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
8089                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
8090
8091                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8092                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[3].input[0].previous_output);
8093
8094                 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
8095                 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
8096                 // a remote commitment tx has already been confirmed).
8097                 check_spends!(node_txn[3], chan.3);
8098
8099                 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
8100                 // output, checked above).
8101                 assert_eq!(node_txn[4].input.len(), 2);
8102                 assert_eq!(node_txn[4].output.len(), 1);
8103                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[3]);
8104
8105                 first = node_txn[4].txid();
8106                 // Store both feerates for later comparison
8107                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[3].output[0].value - node_txn[4].output[0].value;
8108                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
8109                 penalty_txn = vec![node_txn[2].clone()];
8110                 node_txn.clear();
8111         }
8112
8113         // Connect one more block to see if bumped penalty are issued for HTLC txn
8114         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8115         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8116         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8117         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
8118         {
8119                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8120                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
8121
8122                 check_spends!(node_txn[0], revoked_local_txn[0]);
8123                 check_spends!(node_txn[1], revoked_local_txn[0]);
8124                 // Note that these are both bogus - they spend outputs already claimed in block 129:
8125                 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output  {
8126                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[3].input[0].previous_output);
8127                 } else {
8128                         assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[3].input[0].previous_output);
8129                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8130                 }
8131
8132                 node_txn.clear();
8133         };
8134
8135         // Few more blocks to confirm penalty txn
8136         connect_blocks(&nodes[0], 4);
8137         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8138         let header_144 = connect_blocks(&nodes[0], 9);
8139         let node_txn = {
8140                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8141                 assert_eq!(node_txn.len(), 1);
8142
8143                 assert_eq!(node_txn[0].input.len(), 2);
8144                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[3]);
8145                 // Verify bumped tx is different and 25% bump heuristic
8146                 assert_ne!(first, node_txn[0].txid());
8147                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[3].output[0].value - node_txn[0].output[0].value;
8148                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8149                 assert!(feerate_2 * 100 > feerate_1 * 125);
8150                 let txn = vec![node_txn[0].clone()];
8151                 node_txn.clear();
8152                 txn
8153         };
8154         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8155         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8156         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
8157         connect_blocks(&nodes[0], 20);
8158         {
8159                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8160                 // We verify than no new transaction has been broadcast because previously
8161                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8162                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8163                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8164                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8165                 // up bumped justice generation.
8166                 assert_eq!(node_txn.len(), 0);
8167                 node_txn.clear();
8168         }
8169         check_closed_broadcast!(nodes[0], true);
8170         check_added_monitors!(nodes[0], 1);
8171 }
8172
8173 #[test]
8174 fn test_bump_penalty_txn_on_remote_commitment() {
8175         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8176         // we're able to claim outputs on remote commitment transaction before timelocks expiration
8177
8178         // Create 2 HTLCs
8179         // Provide preimage for one
8180         // Check aggregation
8181
8182         let chanmon_cfgs = create_chanmon_cfgs(2);
8183         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8184         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8185         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8186
8187         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8188         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8189         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8190
8191         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8192         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8193         assert_eq!(remote_txn[0].output.len(), 4);
8194         assert_eq!(remote_txn[0].input.len(), 1);
8195         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8196
8197         // Claim a HTLC without revocation (provide B monitor with preimage)
8198         nodes[1].node.claim_funds(payment_preimage);
8199         mine_transaction(&nodes[1], &remote_txn[0]);
8200         check_added_monitors!(nodes[1], 2);
8201         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
8202
8203         // One or more claim tx should have been broadcast, check it
8204         let timeout;
8205         let preimage;
8206         let preimage_bump;
8207         let feerate_timeout;
8208         let feerate_preimage;
8209         {
8210                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8211                 // 9 transactions including:
8212                 // 2*3 ChannelManager local broadcasts of commitment + HTLC-Success + HTLC-Timeout
8213                 // 2 * HTLC-Success (one RBF bump we'll check later)
8214                 // 1 * HTLC-Timeout
8215                 assert_eq!(node_txn.len(), 9);
8216                 assert_eq!(node_txn[0].input.len(), 1);
8217                 assert_eq!(node_txn[7].input.len(), 1);
8218                 check_spends!(node_txn[0], remote_txn[0]);
8219                 check_spends!(node_txn[7], remote_txn[0]);
8220                 assert_eq!(node_txn[0].input[0].previous_output, node_txn[4].input[0].previous_output);
8221                 preimage_bump = node_txn[4].clone();
8222
8223                 check_spends!(node_txn[1], chan.3);
8224                 check_spends!(node_txn[2], node_txn[1]);
8225                 check_spends!(node_txn[3], node_txn[1]);
8226                 assert_eq!(node_txn[1], node_txn[5]);
8227                 assert_eq!(node_txn[2], node_txn[6]);
8228                 assert_eq!(node_txn[3], node_txn[8]);
8229
8230                 timeout = node_txn[7].txid();
8231                 let index = node_txn[7].input[0].previous_output.vout;
8232                 let fee = remote_txn[0].output[index as usize].value - node_txn[7].output[0].value;
8233                 feerate_timeout = fee * 1000 / node_txn[7].get_weight() as u64;
8234
8235                 preimage = node_txn[0].txid();
8236                 let index = node_txn[0].input[0].previous_output.vout;
8237                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8238                 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8239
8240                 node_txn.clear();
8241         };
8242         assert_ne!(feerate_timeout, 0);
8243         assert_ne!(feerate_preimage, 0);
8244
8245         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8246         connect_blocks(&nodes[1], 15);
8247         {
8248                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8249                 assert_eq!(node_txn.len(), 1);
8250                 assert_eq!(node_txn[0].input.len(), 1);
8251                 assert_eq!(preimage_bump.input.len(), 1);
8252                 check_spends!(node_txn[0], remote_txn[0]);
8253                 check_spends!(preimage_bump, remote_txn[0]);
8254
8255                 let index = preimage_bump.input[0].previous_output.vout;
8256                 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
8257                 let new_feerate = fee * 1000 / preimage_bump.get_weight() as u64;
8258                 assert!(new_feerate * 100 > feerate_timeout * 125);
8259                 assert_ne!(timeout, preimage_bump.txid());
8260
8261                 let index = node_txn[0].input[0].previous_output.vout;
8262                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8263                 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8264                 assert!(new_feerate * 100 > feerate_preimage * 125);
8265                 assert_ne!(preimage, node_txn[0].txid());
8266
8267                 node_txn.clear();
8268         }
8269
8270         nodes[1].node.get_and_clear_pending_events();
8271         nodes[1].node.get_and_clear_pending_msg_events();
8272 }
8273
8274 #[test]
8275 fn test_counterparty_raa_skip_no_crash() {
8276         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8277         // commitment transaction, we would have happily carried on and provided them the next
8278         // commitment transaction based on one RAA forward. This would probably eventually have led to
8279         // channel closure, but it would not have resulted in funds loss. Still, our
8280         // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
8281         // check simply that the channel is closed in response to such an RAA, but don't check whether
8282         // we decide to punish our counterparty for revoking their funds (as we don't currently
8283         // implement that).
8284         let chanmon_cfgs = create_chanmon_cfgs(2);
8285         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8286         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8287         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8288         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8289
8290         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8291         let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8292         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8293         let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8294         // Must revoke without gaps
8295         keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8296         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8297                 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8298
8299         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8300                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8301         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8302         check_added_monitors!(nodes[1], 1);
8303 }
8304
8305 #[test]
8306 fn test_bump_txn_sanitize_tracking_maps() {
8307         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8308         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8309
8310         let chanmon_cfgs = create_chanmon_cfgs(2);
8311         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8312         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8313         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8314
8315         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8316         // Lock HTLC in both directions
8317         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8318         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8319
8320         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8321         assert_eq!(revoked_local_txn[0].input.len(), 1);
8322         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8323
8324         // Revoke local commitment tx
8325         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8326
8327         // Broadcast set of revoked txn on A
8328         connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8329         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8330         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8331
8332         mine_transaction(&nodes[0], &revoked_local_txn[0]);
8333         check_closed_broadcast!(nodes[0], true);
8334         check_added_monitors!(nodes[0], 1);
8335         let penalty_txn = {
8336                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8337                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8338                 check_spends!(node_txn[0], revoked_local_txn[0]);
8339                 check_spends!(node_txn[1], revoked_local_txn[0]);
8340                 check_spends!(node_txn[2], revoked_local_txn[0]);
8341                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8342                 node_txn.clear();
8343                 penalty_txn
8344         };
8345         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8346         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8347         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8348         {
8349                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8350                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8351                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8352                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8353                 }
8354         }
8355 }
8356
8357 #[test]
8358 fn test_override_channel_config() {
8359         let chanmon_cfgs = create_chanmon_cfgs(2);
8360         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8361         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8362         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8363
8364         // Node0 initiates a channel to node1 using the override config.
8365         let mut override_config = UserConfig::default();
8366         override_config.own_channel_config.our_to_self_delay = 200;
8367
8368         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8369
8370         // Assert the channel created by node0 is using the override config.
8371         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8372         assert_eq!(res.channel_flags, 0);
8373         assert_eq!(res.to_self_delay, 200);
8374 }
8375
8376 #[test]
8377 fn test_override_0msat_htlc_minimum() {
8378         let mut zero_config = UserConfig::default();
8379         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8380         let chanmon_cfgs = create_chanmon_cfgs(2);
8381         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8382         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8383         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8384
8385         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8386         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8387         assert_eq!(res.htlc_minimum_msat, 1);
8388
8389         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8390         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8391         assert_eq!(res.htlc_minimum_msat, 1);
8392 }
8393
8394 #[test]
8395 fn test_simple_mpp() {
8396         // Simple test of sending a multi-path payment.
8397         let chanmon_cfgs = create_chanmon_cfgs(4);
8398         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8399         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8400         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8401
8402         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8403         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8404         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8405         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8406         let logger = test_utils::TestLogger::new();
8407
8408         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8409         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8410         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();
8411         let path = route.paths[0].clone();
8412         route.paths.push(path);
8413         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8414         route.paths[0][0].short_channel_id = chan_1_id;
8415         route.paths[0][1].short_channel_id = chan_3_id;
8416         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8417         route.paths[1][0].short_channel_id = chan_2_id;
8418         route.paths[1][1].short_channel_id = chan_4_id;
8419         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8420         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8421 }
8422
8423 #[test]
8424 fn test_preimage_storage() {
8425         // Simple test of payment preimage storage allowing no client-side storage to claim payments
8426         let chanmon_cfgs = create_chanmon_cfgs(2);
8427         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8428         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8429         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8430
8431         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8432
8433         {
8434                 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8435
8436                 let logger = test_utils::TestLogger::new();
8437                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8438                 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();
8439                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8440                 check_added_monitors!(nodes[0], 1);
8441                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8442                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8443                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8444                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8445         }
8446         // Note that after leaving the above scope we have no knowledge of any arguments or return
8447         // values from previous calls.
8448         expect_pending_htlcs_forwardable!(nodes[1]);
8449         let events = nodes[1].node.get_and_clear_pending_events();
8450         assert_eq!(events.len(), 1);
8451         match events[0] {
8452                 Event::PaymentReceived { payment_preimage, user_payment_id, .. } => {
8453                         assert_eq!(user_payment_id, 42);
8454                         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8455                 },
8456                 _ => panic!("Unexpected event"),
8457         }
8458 }
8459
8460 #[test]
8461 fn test_secret_timeout() {
8462         // Simple test of payment secret storage time outs
8463         let chanmon_cfgs = create_chanmon_cfgs(2);
8464         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8465         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8466         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8467
8468         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8469
8470         let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8471
8472         // We should fail to register the same payment hash twice, at least until we've connected a
8473         // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8474         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8475                 assert_eq!(err, "Duplicate payment hash");
8476         } else { panic!(); }
8477         let mut block = {
8478                 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8479                 Block {
8480                         header: BlockHeader {
8481                                 version: 0x2000000,
8482                                 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8483                                 merkle_root: Default::default(),
8484                                 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8485                         txdata: vec![],
8486                 }
8487         };
8488         connect_block(&nodes[1], &block);
8489         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8490                 assert_eq!(err, "Duplicate payment hash");
8491         } else { panic!(); }
8492
8493         // If we then connect the second block, we should be able to register the same payment hash
8494         // again with a different user_payment_id (this time getting a new payment secret).
8495         block.header.prev_blockhash = block.header.block_hash();
8496         block.header.time += 1;
8497         connect_block(&nodes[1], &block);
8498         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8499         assert_ne!(payment_secret_1, our_payment_secret);
8500
8501         {
8502                 let logger = test_utils::TestLogger::new();
8503                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8504                 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();
8505                 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8506                 check_added_monitors!(nodes[0], 1);
8507                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8508                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8509                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8510                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8511         }
8512         // Note that after leaving the above scope we have no knowledge of any arguments or return
8513         // values from previous calls.
8514         expect_pending_htlcs_forwardable!(nodes[1]);
8515         let events = nodes[1].node.get_and_clear_pending_events();
8516         assert_eq!(events.len(), 1);
8517         match events[0] {
8518                 Event::PaymentReceived { payment_preimage, payment_secret, user_payment_id, .. } => {
8519                         assert!(payment_preimage.is_none());
8520                         assert_eq!(user_payment_id, 42);
8521                         assert_eq!(payment_secret, our_payment_secret);
8522                         // We don't actually have the payment preimage with which to claim this payment!
8523                 },
8524                 _ => panic!("Unexpected event"),
8525         }
8526 }
8527
8528 #[test]
8529 fn test_bad_secret_hash() {
8530         // Simple test of unregistered payment hash/invalid payment secret handling
8531         let chanmon_cfgs = create_chanmon_cfgs(2);
8532         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8533         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8534         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8535
8536         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8537
8538         let random_payment_hash = PaymentHash([42; 32]);
8539         let random_payment_secret = PaymentSecret([43; 32]);
8540         let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8541
8542         let logger = test_utils::TestLogger::new();
8543         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8544         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();
8545
8546         // All the below cases should end up being handled exactly identically, so we macro the
8547         // resulting events.
8548         macro_rules! handle_unknown_invalid_payment_data {
8549                 () => {
8550                         check_added_monitors!(nodes[0], 1);
8551                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8552                         let payment_event = SendEvent::from_event(events.pop().unwrap());
8553                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8554                         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8555
8556                         // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8557                         // again to process the pending backwards-failure of the HTLC
8558                         expect_pending_htlcs_forwardable!(nodes[1]);
8559                         expect_pending_htlcs_forwardable!(nodes[1]);
8560                         check_added_monitors!(nodes[1], 1);
8561
8562                         // We should fail the payment back
8563                         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8564                         match events.pop().unwrap() {
8565                                 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8566                                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8567                                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8568                                 },
8569                                 _ => panic!("Unexpected event"),
8570                         }
8571                 }
8572         }
8573
8574         let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8575         // Error data is the HTLC value (100,000) and current block height
8576         let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8577
8578         // Send a payment with the right payment hash but the wrong payment secret
8579         nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8580         handle_unknown_invalid_payment_data!();
8581         expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8582
8583         // Send a payment with a random payment hash, but the right payment secret
8584         nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8585         handle_unknown_invalid_payment_data!();
8586         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8587
8588         // Send a payment with a random payment hash and random payment secret
8589         nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8590         handle_unknown_invalid_payment_data!();
8591         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8592 }
8593
8594 #[test]
8595 fn test_update_err_monitor_lockdown() {
8596         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8597         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8598         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8599         //
8600         // This scenario may happen in a watchtower setup, where watchtower process a block height
8601         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8602         // commitment at same time.
8603
8604         let chanmon_cfgs = create_chanmon_cfgs(2);
8605         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8606         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8607         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8608
8609         // Create some initial channel
8610         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8611         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8612
8613         // Rebalance the network to generate htlc in the two directions
8614         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8615
8616         // Route a HTLC from node 0 to node 1 (but don't settle)
8617         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8618
8619         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8620         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8621         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8622         let persister = test_utils::TestPersister::new();
8623         let watchtower = {
8624                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8625                 let monitor = monitors.get(&outpoint).unwrap();
8626                 let mut w = test_utils::TestVecWriter(Vec::new());
8627                 monitor.write(&mut w).unwrap();
8628                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8629                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8630                 assert!(new_monitor == *monitor);
8631                 let watchtower = test_utils::TestChainMonitor::new(Some(&chain_source), &chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
8632                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8633                 watchtower
8634         };
8635         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8636         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8637         // transaction lock time requirements here.
8638         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (header, 0));
8639         watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8640
8641         // Try to update ChannelMonitor
8642         assert!(nodes[1].node.claim_funds(preimage));
8643         check_added_monitors!(nodes[1], 1);
8644         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8645         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8646         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8647         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8648                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8649                         if let Err(_) =  watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8650                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8651                 } else { assert!(false); }
8652         } else { assert!(false); };
8653         // Our local monitor is in-sync and hasn't processed yet timeout
8654         check_added_monitors!(nodes[0], 1);
8655         let events = nodes[0].node.get_and_clear_pending_events();
8656         assert_eq!(events.len(), 1);
8657 }
8658
8659 #[test]
8660 fn test_concurrent_monitor_claim() {
8661         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8662         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8663         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8664         // state N+1 confirms. Alice claims output from state N+1.
8665
8666         let chanmon_cfgs = create_chanmon_cfgs(2);
8667         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8668         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8669         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8670
8671         // Create some initial channel
8672         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8673         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8674
8675         // Rebalance the network to generate htlc in the two directions
8676         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8677
8678         // Route a HTLC from node 0 to node 1 (but don't settle)
8679         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8680
8681         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8682         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8683         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8684         let persister = test_utils::TestPersister::new();
8685         let watchtower_alice = {
8686                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8687                 let monitor = monitors.get(&outpoint).unwrap();
8688                 let mut w = test_utils::TestVecWriter(Vec::new());
8689                 monitor.write(&mut w).unwrap();
8690                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8691                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8692                 assert!(new_monitor == *monitor);
8693                 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);
8694                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8695                 watchtower
8696         };
8697         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8698         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8699         // transaction lock time requirements here.
8700         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (header, 0));
8701         watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8702
8703         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8704         {
8705                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8706                 assert_eq!(txn.len(), 2);
8707                 txn.clear();
8708         }
8709
8710         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8711         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8712         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8713         let persister = test_utils::TestPersister::new();
8714         let watchtower_bob = {
8715                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8716                 let monitor = monitors.get(&outpoint).unwrap();
8717                 let mut w = test_utils::TestVecWriter(Vec::new());
8718                 monitor.write(&mut w).unwrap();
8719                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8720                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8721                 assert!(new_monitor == *monitor);
8722                 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);
8723                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8724                 watchtower
8725         };
8726         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8727         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8728
8729         // Route another payment to generate another update with still previous HTLC pending
8730         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8731         {
8732                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8733                 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();
8734                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8735         }
8736         check_added_monitors!(nodes[1], 1);
8737
8738         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8739         assert_eq!(updates.update_add_htlcs.len(), 1);
8740         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8741         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8742                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8743                         // Watchtower Alice should already have seen the block and reject the update
8744                         if let Err(_) =  watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8745                         if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8746                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8747                 } else { assert!(false); }
8748         } else { assert!(false); };
8749         // Our local monitor is in-sync and hasn't processed yet timeout
8750         check_added_monitors!(nodes[0], 1);
8751
8752         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8753         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8754         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8755
8756         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8757         let bob_state_y;
8758         {
8759                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8760                 assert_eq!(txn.len(), 2);
8761                 bob_state_y = txn[0].clone();
8762                 txn.clear();
8763         };
8764
8765         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8766         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8767         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);
8768         {
8769                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8770                 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8771                 // the onchain detection of the HTLC output
8772                 assert_eq!(htlc_txn.len(), 2);
8773                 check_spends!(htlc_txn[0], bob_state_y);
8774                 check_spends!(htlc_txn[1], bob_state_y);
8775         }
8776 }
8777
8778 #[test]
8779 fn test_pre_lockin_no_chan_closed_update() {
8780         // Test that if a peer closes a channel in response to a funding_created message we don't
8781         // generate a channel update (as the channel cannot appear on chain without a funding_signed
8782         // message).
8783         //
8784         // Doing so would imply a channel monitor update before the initial channel monitor
8785         // registration, violating our API guarantees.
8786         //
8787         // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8788         // then opening a second channel with the same funding output as the first (which is not
8789         // rejected because the first channel does not exist in the ChannelManager) and closing it
8790         // before receiving funding_signed.
8791         let chanmon_cfgs = create_chanmon_cfgs(2);
8792         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8793         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8794         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8795
8796         // Create an initial channel
8797         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8798         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8799         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8800         let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8801         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8802
8803         // Move the first channel through the funding flow...
8804         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8805
8806         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8807         check_added_monitors!(nodes[0], 0);
8808
8809         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8810         let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8811         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8812         assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8813 }
8814
8815 #[test]
8816 fn test_htlc_no_detection() {
8817         // This test is a mutation to underscore the detection logic bug we had
8818         // before #653. HTLC value routed is above the remaining balance, thus
8819         // inverting HTLC and `to_remote` output. HTLC will come second and
8820         // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8821         // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8822         // outputs order detection for correct spending children filtring.
8823
8824         let chanmon_cfgs = create_chanmon_cfgs(2);
8825         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8826         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8827         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8828
8829         // Create some initial channels
8830         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8831
8832         send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8833         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8834         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8835         assert_eq!(local_txn[0].input.len(), 1);
8836         assert_eq!(local_txn[0].output.len(), 3);
8837         check_spends!(local_txn[0], chan_1.3);
8838
8839         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8840         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8841         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8842         // We deliberately connect the local tx twice as this should provoke a failure calling
8843         // this test before #653 fix.
8844         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);
8845         check_closed_broadcast!(nodes[0], true);
8846         check_added_monitors!(nodes[0], 1);
8847         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
8848
8849         let htlc_timeout = {
8850                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8851                 assert_eq!(node_txn[1].input.len(), 1);
8852                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8853                 check_spends!(node_txn[1], local_txn[0]);
8854                 node_txn[1].clone()
8855         };
8856
8857         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8858         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8859         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8860         expect_payment_failed!(nodes[0], our_payment_hash, true);
8861 }
8862
8863 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8864         // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8865         // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8866         // Carol, Alice would be the upstream node, and Carol the downstream.)
8867         //
8868         // Steps of the test:
8869         // 1) Alice sends a HTLC to Carol through Bob.
8870         // 2) Carol doesn't settle the HTLC.
8871         // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8872         // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8873         // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8874         //    but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8875         // 5) Carol release the preimage to Bob off-chain.
8876         // 6) Bob claims the offered output on the broadcasted commitment.
8877         let chanmon_cfgs = create_chanmon_cfgs(3);
8878         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8879         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8880         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8881
8882         // Create some initial channels
8883         let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8884         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8885
8886         // Steps (1) and (2):
8887         // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8888         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8889
8890         // Check that Alice's commitment transaction now contains an output for this HTLC.
8891         let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8892         check_spends!(alice_txn[0], chan_ab.3);
8893         assert_eq!(alice_txn[0].output.len(), 2);
8894         check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8895         assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8896         assert_eq!(alice_txn.len(), 2);
8897
8898         // Steps (3) and (4):
8899         // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8900         // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8901         let mut force_closing_node = 0; // Alice force-closes
8902         if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8903         nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8904         check_closed_broadcast!(nodes[force_closing_node], true);
8905         check_added_monitors!(nodes[force_closing_node], 1);
8906         if go_onchain_before_fulfill {
8907                 let txn_to_broadcast = match broadcast_alice {
8908                         true => alice_txn.clone(),
8909                         false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8910                 };
8911                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8912                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8913                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8914                 if broadcast_alice {
8915                         check_closed_broadcast!(nodes[1], true);
8916                         check_added_monitors!(nodes[1], 1);
8917                 }
8918                 assert_eq!(bob_txn.len(), 1);
8919                 check_spends!(bob_txn[0], chan_ab.3);
8920         }
8921
8922         // Step (5):
8923         // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8924         // process of removing the HTLC from their commitment transactions.
8925         assert!(nodes[2].node.claim_funds(payment_preimage));
8926         check_added_monitors!(nodes[2], 1);
8927         let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8928         assert!(carol_updates.update_add_htlcs.is_empty());
8929         assert!(carol_updates.update_fail_htlcs.is_empty());
8930         assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8931         assert!(carol_updates.update_fee.is_none());
8932         assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8933
8934         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8935         // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8936         if !go_onchain_before_fulfill && broadcast_alice {
8937                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8938                 assert_eq!(events.len(), 1);
8939                 match events[0] {
8940                         MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8941                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8942                         },
8943                         _ => panic!("Unexpected event"),
8944                 };
8945         }
8946         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8947         // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8948         // Carol<->Bob's updated commitment transaction info.
8949         check_added_monitors!(nodes[1], 2);
8950
8951         let events = nodes[1].node.get_and_clear_pending_msg_events();
8952         assert_eq!(events.len(), 2);
8953         let bob_revocation = match events[0] {
8954                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8955                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8956                         (*msg).clone()
8957                 },
8958                 _ => panic!("Unexpected event"),
8959         };
8960         let bob_updates = match events[1] {
8961                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8962                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8963                         (*updates).clone()
8964                 },
8965                 _ => panic!("Unexpected event"),
8966         };
8967
8968         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8969         check_added_monitors!(nodes[2], 1);
8970         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8971         check_added_monitors!(nodes[2], 1);
8972
8973         let events = nodes[2].node.get_and_clear_pending_msg_events();
8974         assert_eq!(events.len(), 1);
8975         let carol_revocation = match events[0] {
8976                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8977                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8978                         (*msg).clone()
8979                 },
8980                 _ => panic!("Unexpected event"),
8981         };
8982         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8983         check_added_monitors!(nodes[1], 1);
8984
8985         // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8986         // here's where we put said channel's commitment tx on-chain.
8987         let mut txn_to_broadcast = alice_txn.clone();
8988         if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8989         if !go_onchain_before_fulfill {
8990                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8991                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8992                 // If Bob was the one to force-close, he will have already passed these checks earlier.
8993                 if broadcast_alice {
8994                         check_closed_broadcast!(nodes[1], true);
8995                         check_added_monitors!(nodes[1], 1);
8996                 }
8997                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8998                 if broadcast_alice {
8999                         // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
9000                         // new block being connected. The ChannelManager being notified triggers a monitor update,
9001                         // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
9002                         // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
9003                         // broadcasted.
9004                         assert_eq!(bob_txn.len(), 3);
9005                         check_spends!(bob_txn[1], chan_ab.3);
9006                 } else {
9007                         assert_eq!(bob_txn.len(), 2);
9008                         check_spends!(bob_txn[0], chan_ab.3);
9009                 }
9010         }
9011
9012         // Step (6):
9013         // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
9014         // broadcasted commitment transaction.
9015         {
9016                 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
9017                 if go_onchain_before_fulfill {
9018                         // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
9019                         assert_eq!(bob_txn.len(), 2);
9020                 }
9021                 let script_weight = match broadcast_alice {
9022                         true => OFFERED_HTLC_SCRIPT_WEIGHT,
9023                         false => ACCEPTED_HTLC_SCRIPT_WEIGHT
9024                 };
9025                 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
9026                 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
9027                 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
9028                 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
9029                 if broadcast_alice && !go_onchain_before_fulfill {
9030                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
9031                         assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
9032                 } else {
9033                         check_spends!(bob_txn[1], txn_to_broadcast[0]);
9034                         assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
9035                 }
9036         }
9037 }
9038
9039 #[test]
9040 fn test_onchain_htlc_settlement_after_close() {
9041         do_test_onchain_htlc_settlement_after_close(true, true);
9042         do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
9043         do_test_onchain_htlc_settlement_after_close(true, false);
9044         do_test_onchain_htlc_settlement_after_close(false, false);
9045 }
9046
9047 #[test]
9048 fn test_duplicate_chan_id() {
9049         // Test that if a given peer tries to open a channel with the same channel_id as one that is
9050         // already open we reject it and keep the old channel.
9051         //
9052         // Previously, full_stack_target managed to figure out that if you tried to open two channels
9053         // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
9054         // the existing channel when we detect the duplicate new channel, screwing up our monitor
9055         // updating logic for the existing channel.
9056         let chanmon_cfgs = create_chanmon_cfgs(2);
9057         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9058         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9059         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9060
9061         // Create an initial channel
9062         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9063         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9064         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9065         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
9066
9067         // Try to create a second channel with the same temporary_channel_id as the first and check
9068         // that it is rejected.
9069         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9070         {
9071                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9072                 assert_eq!(events.len(), 1);
9073                 match events[0] {
9074                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9075                                 // Technically, at this point, nodes[1] would be justified in thinking both the
9076                                 // first (valid) and second (invalid) channels are closed, given they both have
9077                                 // the same non-temporary channel_id. However, currently we do not, so we just
9078                                 // move forward with it.
9079                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9080                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9081                         },
9082                         _ => panic!("Unexpected event"),
9083                 }
9084         }
9085
9086         // Move the first channel through the funding flow...
9087         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
9088
9089         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9090         check_added_monitors!(nodes[0], 0);
9091
9092         let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9093         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9094         {
9095                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9096                 assert_eq!(added_monitors.len(), 1);
9097                 assert_eq!(added_monitors[0].0, funding_output);
9098                 added_monitors.clear();
9099         }
9100         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9101
9102         let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
9103         let channel_id = funding_outpoint.to_channel_id();
9104
9105         // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
9106         // temporary one).
9107
9108         // First try to open a second channel with a temporary channel id equal to the txid-based one.
9109         // Technically this is allowed by the spec, but we don't support it and there's little reason
9110         // to. Still, it shouldn't cause any other issues.
9111         open_chan_msg.temporary_channel_id = channel_id;
9112         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9113         {
9114                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9115                 assert_eq!(events.len(), 1);
9116                 match events[0] {
9117                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9118                                 // Technically, at this point, nodes[1] would be justified in thinking both
9119                                 // channels are closed, but currently we do not, so we just move forward with it.
9120                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9121                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9122                         },
9123                         _ => panic!("Unexpected event"),
9124                 }
9125         }
9126
9127         // Now try to create a second channel which has a duplicate funding output.
9128         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9129         let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9130         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
9131         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()));
9132         create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
9133
9134         let funding_created = {
9135                 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
9136                 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
9137                 let logger = test_utils::TestLogger::new();
9138                 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
9139         };
9140         check_added_monitors!(nodes[0], 0);
9141         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
9142         // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
9143         // still needs to be cleared here.
9144         check_added_monitors!(nodes[1], 1);
9145
9146         // ...still, nodes[1] will reject the duplicate channel.
9147         {
9148                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9149                 assert_eq!(events.len(), 1);
9150                 match events[0] {
9151                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9152                                 // Technically, at this point, nodes[1] would be justified in thinking both
9153                                 // channels are closed, but currently we do not, so we just move forward with it.
9154                                 assert_eq!(msg.channel_id, channel_id);
9155                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9156                         },
9157                         _ => panic!("Unexpected event"),
9158                 }
9159         }
9160
9161         // finally, finish creating the original channel and send a payment over it to make sure
9162         // everything is functional.
9163         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9164         {
9165                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9166                 assert_eq!(added_monitors.len(), 1);
9167                 assert_eq!(added_monitors[0].0, funding_output);
9168                 added_monitors.clear();
9169         }
9170
9171         let events_4 = nodes[0].node.get_and_clear_pending_events();
9172         assert_eq!(events_4.len(), 0);
9173         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9174         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
9175
9176         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9177         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9178         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9179         send_payment(&nodes[0], &[&nodes[1]], 8000000);
9180 }
9181
9182 #[test]
9183 fn test_error_chans_closed() {
9184         // Test that we properly handle error messages, closing appropriate channels.
9185         //
9186         // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9187         // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9188         // we can test various edge cases around it to ensure we don't regress.
9189         let chanmon_cfgs = create_chanmon_cfgs(3);
9190         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9191         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9192         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9193
9194         // Create some initial channels
9195         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9196         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9197         let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9198
9199         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9200         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9201         assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9202
9203         // Closing a channel from a different peer has no effect
9204         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9205         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9206
9207         // Closing one channel doesn't impact others
9208         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9209         check_added_monitors!(nodes[0], 1);
9210         check_closed_broadcast!(nodes[0], false);
9211         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9212         assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9213         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);
9214         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);
9215
9216         // A null channel ID should close all channels
9217         let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9218         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9219         check_added_monitors!(nodes[0], 2);
9220         let events = nodes[0].node.get_and_clear_pending_msg_events();
9221         assert_eq!(events.len(), 2);
9222         match events[0] {
9223                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9224                         assert_eq!(msg.contents.flags & 2, 2);
9225                 },
9226                 _ => panic!("Unexpected event"),
9227         }
9228         match events[1] {
9229                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9230                         assert_eq!(msg.contents.flags & 2, 2);
9231                 },
9232                 _ => panic!("Unexpected event"),
9233         }
9234         // Note that at this point users of a standard PeerHandler will end up calling
9235         // peer_disconnected with no_connection_possible set to false, duplicating the
9236         // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9237         // users with their own peer handling logic. We duplicate the call here, however.
9238         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9239         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9240
9241         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9242         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9243         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9244 }
9245
9246 #[test]
9247 fn test_invalid_funding_tx() {
9248         // Test that we properly handle invalid funding transactions sent to us from a peer.
9249         //
9250         // Previously, all other major lightning implementations had failed to properly sanitize
9251         // funding transactions from their counterparties, leading to a multi-implementation critical
9252         // security vulnerability (though we always sanitized properly, we've previously had
9253         // un-released crashes in the sanitization process).
9254         let chanmon_cfgs = create_chanmon_cfgs(2);
9255         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9256         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9257         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9258
9259         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9260         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()));
9261         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()));
9262
9263         let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9264         for output in tx.output.iter_mut() {
9265                 // Make the confirmed funding transaction have a bogus script_pubkey
9266                 output.script_pubkey = bitcoin::Script::new();
9267         }
9268
9269         nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9270         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()));
9271         check_added_monitors!(nodes[1], 1);
9272
9273         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()));
9274         check_added_monitors!(nodes[0], 1);
9275
9276         let events_1 = nodes[0].node.get_and_clear_pending_events();
9277         assert_eq!(events_1.len(), 0);
9278
9279         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9280         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9281         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9282
9283         confirm_transaction_at(&nodes[1], &tx, 1);
9284         check_added_monitors!(nodes[1], 1);
9285         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9286         assert_eq!(events_2.len(), 1);
9287         if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9288                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9289                 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9290                         assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9291                 } else { panic!(); }
9292         } else { panic!(); }
9293         assert_eq!(nodes[1].node.list_channels().len(), 0);
9294 }