_ 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::Watch;
  15 use chain::channelmonitor;
  16 use chain::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
  17 use chain::transaction::OutPoint;
  18 use chain::keysinterface::{ChannelKeys, KeysInterface};
  19 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
  20 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentPreimage, PaymentHash, PaymentSecret, PaymentSendFailure, BREAKDOWN_TIMEOUT};
  21 use ln::channel::{Channel, ChannelError};
  22 use ln::{chan_utils, onion_utils};
  23 use routing::router::{Route, RouteHop, get_route};
  24 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
  25 use ln::msgs;
  26 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
  27 use util::enforcing_trait_impls::EnforcingChannelKeys;
  28 use util::{byte_utils, test_utils};
  29 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
  30 use util::errors::APIError;
  31 use util::ser::{Writeable, ReadableArgs};
  32 use util::config::UserConfig;
  33
  34 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
  35 use bitcoin::hash_types::{Txid, BlockHash};
  36 use bitcoin::blockdata::block::{Block, BlockHeader};
  37 use bitcoin::blockdata::script::Builder;
  38 use bitcoin::blockdata::opcodes;
  39 use bitcoin::blockdata::constants::genesis_block;
  40 use bitcoin::network::constants::Network;
  41
  42 use bitcoin::hashes::sha256::Hash as Sha256;
  43 use bitcoin::hashes::Hash;
  44
  45 use bitcoin::secp256k1::{Secp256k1, Message};
  46 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
  47
  48 use regex;
  49
  50 use std::collections::{BTreeSet, HashMap, HashSet};
  51 use std::default::Default;
  52 use std::sync::Mutex;
  53 use std::sync::atomic::Ordering;
  54 use std::mem;
  55
  56 use ln::functional_test_utils::*;
  57 use ln::chan_utils::CommitmentTransaction;
  58
  59 #[test]
  60 fn test_insane_channel_opens() {
  61         // Stand up a network of 2 nodes
  62         let chanmon_cfgs = create_chanmon_cfgs(2);
  63         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  64         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  65         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  66
  67         // Instantiate channel parameters where we push the maximum msats given our
  68         // funding satoshis
  69         let channel_value_sat = 31337; // same as funding satoshis
  70         let channel_reserve_satoshis = Channel::<EnforcingChannelKeys>::get_holder_selected_channel_reserve_satoshis(channel_value_sat);
  71         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  72
  73         // Have node0 initiate a channel to node1 with aforementioned parameters
  74         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
  75
  76         // Extract the channel open message from node0 to node1
  77         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  78
  79         // Test helper that asserts we get the correct error string given a mutator
  80         // that supposedly makes the channel open message insane
  81         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  82                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
  83                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  84                 assert_eq!(msg_events.len(), 1);
  85                 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
  86                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  87                         match action {
  88                                 &ErrorAction::SendErrorMessage { .. } => {
  89                                         nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
  90                                 },
  91                                 _ => panic!("unexpected event!"),
  92                         }
  93                 } else { assert!(false); }
  94         };
  95
  96         use ln::channel::MAX_FUNDING_SATOSHIS;
  97         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
  98
  99         // Test all mutations that would make the channel open message insane
 100         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 });
 101
 102         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
 103
 104         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 });
 105
 106         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
 107
 108         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 });
 109
 110         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 });
 111
 112         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 });
 113
 114         insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 115
 116         insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 117 }
 118
 119 #[test]
 120 fn test_async_inbound_update_fee() {
 121         let chanmon_cfgs = create_chanmon_cfgs(2);
 122         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 123         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 124         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 125         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 126         let logger = test_utils::TestLogger::new();
 127         let channel_id = chan.2;
 128
 129         // balancing
 130         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 131
 132         // A                                        B
 133         // update_fee                            ->
 134         // send (1) commitment_signed            -.
 135         //                                       <- update_add_htlc/commitment_signed
 136         // send (2) RAA (awaiting remote revoke) -.
 137         // (1) commitment_signed is delivered    ->
 138         //                                       .- send (3) RAA (awaiting remote revoke)
 139         // (2) RAA is delivered                  ->
 140         //                                       .- send (4) commitment_signed
 141         //                                       <- (3) RAA is delivered
 142         // send (5) commitment_signed            -.
 143         //                                       <- (4) commitment_signed is delivered
 144         // send (6) RAA                          -.
 145         // (5) commitment_signed is delivered    ->
 146         //                                       <- RAA
 147         // (6) RAA is delivered                  ->
 148
 149         // First nodes[0] generates an update_fee
 150         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 151         check_added_monitors!(nodes[0], 1);
 152
 153         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 154         assert_eq!(events_0.len(), 1);
 155         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 156                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 157                         (update_fee.as_ref(), commitment_signed)
 158                 },
 159                 _ => panic!("Unexpected event"),
 160         };
 161
 162         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 163
 164         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 165         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 166         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 167         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(), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &None).unwrap();
 168         check_added_monitors!(nodes[1], 1);
 169
 170         let payment_event = {
 171                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 172                 assert_eq!(events_1.len(), 1);
 173                 SendEvent::from_event(events_1.remove(0))
 174         };
 175         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 176         assert_eq!(payment_event.msgs.len(), 1);
 177
 178         // ...now when the messages get delivered everyone should be happy
 179         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 180         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 181         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 182         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 183         check_added_monitors!(nodes[0], 1);
 184
 185         // deliver(1), generate (3):
 186         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 187         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 188         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 189         check_added_monitors!(nodes[1], 1);
 190
 191         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 192         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 193         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 194         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 195         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 196         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 197         assert!(bs_update.update_fee.is_none()); // (4)
 198         check_added_monitors!(nodes[1], 1);
 199
 200         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 201         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 202         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 203         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 204         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 205         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 206         assert!(as_update.update_fee.is_none()); // (5)
 207         check_added_monitors!(nodes[0], 1);
 208
 209         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 210         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 211         // only (6) so get_event_msg's assert(len == 1) passes
 212         check_added_monitors!(nodes[0], 1);
 213
 214         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 215         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 216         check_added_monitors!(nodes[1], 1);
 217
 218         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 219         check_added_monitors!(nodes[0], 1);
 220
 221         let events_2 = nodes[0].node.get_and_clear_pending_events();
 222         assert_eq!(events_2.len(), 1);
 223         match events_2[0] {
 224                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 225                 _ => panic!("Unexpected event"),
 226         }
 227
 228         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 229         check_added_monitors!(nodes[1], 1);
 230 }
 231
 232 #[test]
 233 fn test_update_fee_unordered_raa() {
 234         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 235         // crash in an earlier version of the update_fee patch)
 236         let chanmon_cfgs = create_chanmon_cfgs(2);
 237         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 238         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 239         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 240         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 241         let channel_id = chan.2;
 242         let logger = test_utils::TestLogger::new();
 243
 244         // balancing
 245         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 246
 247         // First nodes[0] generates an update_fee
 248         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 249         check_added_monitors!(nodes[0], 1);
 250
 251         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 252         assert_eq!(events_0.len(), 1);
 253         let update_msg = match events_0[0] { // (1)
 254                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 255                         update_fee.as_ref()
 256                 },
 257                 _ => panic!("Unexpected event"),
 258         };
 259
 260         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 261
 262         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 263         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 264         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 265         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(), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &None).unwrap();
 266         check_added_monitors!(nodes[1], 1);
 267
 268         let payment_event = {
 269                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 270                 assert_eq!(events_1.len(), 1);
 271                 SendEvent::from_event(events_1.remove(0))
 272         };
 273         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 274         assert_eq!(payment_event.msgs.len(), 1);
 275
 276         // ...now when the messages get delivered everyone should be happy
 277         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 278         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 279         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 280         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 281         check_added_monitors!(nodes[0], 1);
 282
 283         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 284         check_added_monitors!(nodes[1], 1);
 285
 286         // We can't continue, sadly, because our (1) now has a bogus signature
 287 }
 288
 289 #[test]
 290 fn test_multi_flight_update_fee() {
 291         let chanmon_cfgs = create_chanmon_cfgs(2);
 292         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 293         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 294         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 295         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 296         let channel_id = chan.2;
 297
 298         // A                                        B
 299         // update_fee/commitment_signed          ->
 300         //                                       .- send (1) RAA and (2) commitment_signed
 301         // update_fee (never committed)          ->
 302         // (3) update_fee                        ->
 303         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 304         // don't track which updates correspond to which revoke_and_ack responses so we're in
 305         // AwaitingRAA mode and will not generate the update_fee yet.
 306         //                                       <- (1) RAA delivered
 307         // (3) is generated and send (4) CS      -.
 308         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 309         // know the per_commitment_point to use for it.
 310         //                                       <- (2) commitment_signed delivered
 311         // revoke_and_ack                        ->
 312         //                                          B should send no response here
 313         // (4) commitment_signed delivered       ->
 314         //                                       <- RAA/commitment_signed delivered
 315         // revoke_and_ack                        ->
 316
 317         // First nodes[0] generates an update_fee
 318         let initial_feerate = get_feerate!(nodes[0], channel_id);
 319         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
 320         check_added_monitors!(nodes[0], 1);
 321
 322         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 323         assert_eq!(events_0.len(), 1);
 324         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 325                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 326                         (update_fee.as_ref().unwrap(), commitment_signed)
 327                 },
 328                 _ => panic!("Unexpected event"),
 329         };
 330
 331         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 332         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 333         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 334         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 335         check_added_monitors!(nodes[1], 1);
 336
 337         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 338         // transaction:
 339         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
 340         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 341         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 342
 343         // Create the (3) update_fee message that nodes[0] will generate before it does...
 344         let mut update_msg_2 = msgs::UpdateFee {
 345                 channel_id: update_msg_1.channel_id.clone(),
 346                 feerate_per_kw: (initial_feerate + 30) as u32,
 347         };
 348
 349         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 350
 351         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 352         // Deliver (3)
 353         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 354
 355         // Deliver (1), generating (3) and (4)
 356         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 357         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 358         check_added_monitors!(nodes[0], 1);
 359         assert!(as_second_update.update_add_htlcs.is_empty());
 360         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 361         assert!(as_second_update.update_fail_htlcs.is_empty());
 362         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 363         // Check that the update_fee newly generated matches what we delivered:
 364         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 365         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 366
 367         // Deliver (2) commitment_signed
 368         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 369         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 370         check_added_monitors!(nodes[0], 1);
 371         // No commitment_signed so get_event_msg's assert(len == 1) passes
 372
 373         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 374         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 375         check_added_monitors!(nodes[1], 1);
 376
 377         // Delever (4)
 378         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 379         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 380         check_added_monitors!(nodes[1], 1);
 381
 382         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 383         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 384         check_added_monitors!(nodes[0], 1);
 385
 386         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 387         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 388         // No commitment_signed so get_event_msg's assert(len == 1) passes
 389         check_added_monitors!(nodes[0], 1);
 390
 391         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 392         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 393         check_added_monitors!(nodes[1], 1);
 394 }
 395
 396 #[test]
 397 fn test_1_conf_open() {
 398         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 399         // tests that we properly send one in that case.
 400         let mut alice_config = UserConfig::default();
 401         alice_config.own_channel_config.minimum_depth = 1;
 402         alice_config.channel_options.announced_channel = true;
 403         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 404         let mut bob_config = UserConfig::default();
 405         bob_config.own_channel_config.minimum_depth = 1;
 406         bob_config.channel_options.announced_channel = true;
 407         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 408         let chanmon_cfgs = create_chanmon_cfgs(2);
 409         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 410         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 411         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 412
 413         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
 414         let block = Block {
 415                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 416                 txdata: vec![tx],
 417         };
 418         connect_block(&nodes[1], &block, 1);
 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         connect_block(&nodes[0], &block, 1);
 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
 432 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 433         // Previously, we had issues deserializing channels when we hadn't connected the first block
 434         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 435         // serialization round-trips and simply do steps towards opening a channel and then drop the
 436         // Node objects.
 437
 438         let chanmon_cfgs = create_chanmon_cfgs(2);
 439         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 440         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 441         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 442
 443         if steps & 0b1000_0000 != 0{
 444                 let block = Block {
 445                         header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 446                         txdata: vec![],
 447                 };
 448                 connect_block(&nodes[0], &block, 1);
 449                 connect_block(&nodes[1], &block, 1);
 450         }
 451
 452         if steps & 0x0f == 0 { return; }
 453         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 454         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 455
 456         if steps & 0x0f == 1 { return; }
 457         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
 458         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 459
 460         if steps & 0x0f == 2 { return; }
 461         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
 462
 463         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 464
 465         if steps & 0x0f == 3 { return; }
 466         nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
 467         check_added_monitors!(nodes[0], 0);
 468         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 469
 470         if steps & 0x0f == 4 { return; }
 471         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 472         {
 473                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 474                 assert_eq!(added_monitors.len(), 1);
 475                 assert_eq!(added_monitors[0].0, funding_output);
 476                 added_monitors.clear();
 477         }
 478         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 479
 480         if steps & 0x0f == 5 { return; }
 481         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 482         {
 483                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 484                 assert_eq!(added_monitors.len(), 1);
 485                 assert_eq!(added_monitors[0].0, funding_output);
 486                 added_monitors.clear();
 487         }
 488
 489         let events_4 = nodes[0].node.get_and_clear_pending_events();
 490         assert_eq!(events_4.len(), 1);
 491         match events_4[0] {
 492                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
 493                         assert_eq!(user_channel_id, 42);
 494                         assert_eq!(*funding_txo, funding_output);
 495                 },
 496                 _ => panic!("Unexpected event"),
 497         };
 498
 499         if steps & 0x0f == 6 { return; }
 500         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx);
 501
 502         if steps & 0x0f == 7 { return; }
 503         confirm_transaction(&nodes[0], &tx);
 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, 8_000_000);
 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) = get_payment_preimage_hash!(nodes[1]);
 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(), 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, &None).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, 800_000);
 712
 713         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
 714         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
 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         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 830         connect_block(&nodes[0], &Block { header, txdata: vec![tx.clone()]}, 1);
 831         connect_block(&nodes[1], &Block { header, txdata: vec![tx.clone()]}, 1);
 832
 833         nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
 834         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 835         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 836         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 837         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 838
 839         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 840         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 841         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 842         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 843         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 844         assert!(node_0_none.is_none());
 845
 846         assert!(nodes[0].node.list_channels().is_empty());
 847         assert!(nodes[1].node.list_channels().is_empty());
 848 }
 849
 850 #[test]
 851 fn updates_shutdown_wait() {
 852         // Test sending a shutdown with outstanding updates pending
 853         let chanmon_cfgs = create_chanmon_cfgs(3);
 854         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 855         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 856         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 857         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 858         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 859         let logger = test_utils::TestLogger::new();
 860
 861         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 862
 863         nodes[0].node.close_channel(&chan_1.2).unwrap();
 864         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 865         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 866         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 867         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 868
 869         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 870         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 871
 872         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
 873
 874         let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
 875         let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
 876         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 877         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 878         unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 879         unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 880
 881         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
 882         check_added_monitors!(nodes[2], 1);
 883         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 884         assert!(updates.update_add_htlcs.is_empty());
 885         assert!(updates.update_fail_htlcs.is_empty());
 886         assert!(updates.update_fail_malformed_htlcs.is_empty());
 887         assert!(updates.update_fee.is_none());
 888         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 889         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 890         check_added_monitors!(nodes[1], 1);
 891         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 892         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 893
 894         assert!(updates_2.update_add_htlcs.is_empty());
 895         assert!(updates_2.update_fail_htlcs.is_empty());
 896         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 897         assert!(updates_2.update_fee.is_none());
 898         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 899         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 900         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 901
 902         let events = nodes[0].node.get_and_clear_pending_events();
 903         assert_eq!(events.len(), 1);
 904         match events[0] {
 905                 Event::PaymentSent { ref payment_preimage } => {
 906                         assert_eq!(our_payment_preimage, *payment_preimage);
 907                 },
 908                 _ => panic!("Unexpected event"),
 909         }
 910
 911         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 912         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 913         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 914         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 915         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 916         assert!(node_0_none.is_none());
 917
 918         assert!(nodes[0].node.list_channels().is_empty());
 919
 920         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 921         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 922         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 923         assert!(nodes[1].node.list_channels().is_empty());
 924         assert!(nodes[2].node.list_channels().is_empty());
 925 }
 926
 927 #[test]
 928 fn htlc_fail_async_shutdown() {
 929         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 930         let chanmon_cfgs = create_chanmon_cfgs(3);
 931         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 932         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 933         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 934         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 935         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 936         let logger = test_utils::TestLogger::new();
 937
 938         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 939         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
 940         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 941         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
 942         check_added_monitors!(nodes[0], 1);
 943         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 944         assert_eq!(updates.update_add_htlcs.len(), 1);
 945         assert!(updates.update_fulfill_htlcs.is_empty());
 946         assert!(updates.update_fail_htlcs.is_empty());
 947         assert!(updates.update_fail_malformed_htlcs.is_empty());
 948         assert!(updates.update_fee.is_none());
 949
 950         nodes[1].node.close_channel(&chan_1.2).unwrap();
 951         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 952         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 953         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 954
 955         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 956         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 957         check_added_monitors!(nodes[1], 1);
 958         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 959         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 960
 961         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 962         assert!(updates_2.update_add_htlcs.is_empty());
 963         assert!(updates_2.update_fulfill_htlcs.is_empty());
 964         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 965         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 966         assert!(updates_2.update_fee.is_none());
 967
 968         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 969         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 970
 971         expect_payment_failed!(nodes[0], our_payment_hash, false);
 972
 973         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 974         assert_eq!(msg_events.len(), 2);
 975         let node_0_closing_signed = match msg_events[0] {
 976                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 977                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 978                         (*msg).clone()
 979                 },
 980                 _ => panic!("Unexpected event"),
 981         };
 982         match msg_events[1] {
 983                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 984                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 985                 },
 986                 _ => panic!("Unexpected event"),
 987         }
 988
 989         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 990         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 991         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 992         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 993         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 994         assert!(node_0_none.is_none());
 995
 996         assert!(nodes[0].node.list_channels().is_empty());
 997
 998         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 999         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1000         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1001         assert!(nodes[1].node.list_channels().is_empty());
1002         assert!(nodes[2].node.list_channels().is_empty());
1003 }
1004
1005 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1006         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1007         // messages delivered prior to disconnect
1008         let chanmon_cfgs = create_chanmon_cfgs(3);
1009         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1010         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1011         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1012         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1013         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1014
1015         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1016
1017         nodes[1].node.close_channel(&chan_1.2).unwrap();
1018         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1019         if recv_count > 0 {
1020                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1021                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1022                 if recv_count > 1 {
1023                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1024                 }
1025         }
1026
1027         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1028         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1029
1030         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1031         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1032         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1033         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1034
1035         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1036         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1037         assert!(node_1_shutdown == node_1_2nd_shutdown);
1038
1039         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1040         let node_0_2nd_shutdown = if recv_count > 0 {
1041                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1042                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1043                 node_0_2nd_shutdown
1044         } else {
1045                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1046                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1047                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1048         };
1049         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
1050
1051         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1052         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1053
1054         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
1055         check_added_monitors!(nodes[2], 1);
1056         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1057         assert!(updates.update_add_htlcs.is_empty());
1058         assert!(updates.update_fail_htlcs.is_empty());
1059         assert!(updates.update_fail_malformed_htlcs.is_empty());
1060         assert!(updates.update_fee.is_none());
1061         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1062         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1063         check_added_monitors!(nodes[1], 1);
1064         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1065         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1066
1067         assert!(updates_2.update_add_htlcs.is_empty());
1068         assert!(updates_2.update_fail_htlcs.is_empty());
1069         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1070         assert!(updates_2.update_fee.is_none());
1071         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1072         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1073         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1074
1075         let events = nodes[0].node.get_and_clear_pending_events();
1076         assert_eq!(events.len(), 1);
1077         match events[0] {
1078                 Event::PaymentSent { ref payment_preimage } => {
1079                         assert_eq!(our_payment_preimage, *payment_preimage);
1080                 },
1081                 _ => panic!("Unexpected event"),
1082         }
1083
1084         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1085         if recv_count > 0 {
1086                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1087                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1088                 assert!(node_1_closing_signed.is_some());
1089         }
1090
1091         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1092         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1093
1094         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1095         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1096         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1097         if recv_count == 0 {
1098                 // If all closing_signeds weren't delivered we can just resume where we left off...
1099                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1100
1101                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1102                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1103                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1104
1105                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1106                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1107                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1108
1109                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
1110                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1111
1112                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
1113                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1114                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1115
1116                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1117                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1118                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1119                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1120                 assert!(node_0_none.is_none());
1121         } else {
1122                 // If one node, however, received + responded with an identical closing_signed we end
1123                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1124                 // There isn't really anything better we can do simply, but in the future we might
1125                 // explore storing a set of recently-closed channels that got disconnected during
1126                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1127                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1128                 // transaction.
1129                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1130
1131                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1132                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1133                 assert_eq!(msg_events.len(), 1);
1134                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1135                         match action {
1136                                 &ErrorAction::SendErrorMessage { ref msg } => {
1137                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1138                                         assert_eq!(msg.channel_id, chan_1.2);
1139                                 },
1140                                 _ => panic!("Unexpected event!"),
1141                         }
1142                 } else { panic!("Needed SendErrorMessage close"); }
1143
1144                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1145                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1146                 // closing_signed so we do it ourselves
1147                 check_closed_broadcast!(nodes[0], false);
1148                 check_added_monitors!(nodes[0], 1);
1149         }
1150
1151         assert!(nodes[0].node.list_channels().is_empty());
1152
1153         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1154         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1155         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1156         assert!(nodes[1].node.list_channels().is_empty());
1157         assert!(nodes[2].node.list_channels().is_empty());
1158 }
1159
1160 #[test]
1161 fn test_shutdown_rebroadcast() {
1162         do_test_shutdown_rebroadcast(0);
1163         do_test_shutdown_rebroadcast(1);
1164         do_test_shutdown_rebroadcast(2);
1165 }
1166
1167 #[test]
1168 fn fake_network_test() {
1169         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1170         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1171         let chanmon_cfgs = create_chanmon_cfgs(4);
1172         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1173         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1174         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1175
1176         // Create some initial channels
1177         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1178         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1179         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1180
1181         // Rebalance the network a bit by relaying one payment through all the channels...
1182         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1183         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1184         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1185         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1186
1187         // Send some more payments
1188         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1189         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1190         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1191
1192         // Test failure packets
1193         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1194         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1195
1196         // Add a new channel that skips 3
1197         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1198
1199         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1200         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1201         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1202         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1203         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1204         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1205         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1206
1207         // Do some rebalance loop payments, simultaneously
1208         let mut hops = Vec::with_capacity(3);
1209         hops.push(RouteHop {
1210                 pubkey: nodes[2].node.get_our_node_id(),
1211                 node_features: NodeFeatures::empty(),
1212                 short_channel_id: chan_2.0.contents.short_channel_id,
1213                 channel_features: ChannelFeatures::empty(),
1214                 fee_msat: 0,
1215                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1216         });
1217         hops.push(RouteHop {
1218                 pubkey: nodes[3].node.get_our_node_id(),
1219                 node_features: NodeFeatures::empty(),
1220                 short_channel_id: chan_3.0.contents.short_channel_id,
1221                 channel_features: ChannelFeatures::empty(),
1222                 fee_msat: 0,
1223                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1224         });
1225         hops.push(RouteHop {
1226                 pubkey: nodes[1].node.get_our_node_id(),
1227                 node_features: NodeFeatures::empty(),
1228                 short_channel_id: chan_4.0.contents.short_channel_id,
1229                 channel_features: ChannelFeatures::empty(),
1230                 fee_msat: 1000000,
1231                 cltv_expiry_delta: TEST_FINAL_CLTV,
1232         });
1233         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;
1234         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;
1235         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1236
1237         let mut hops = Vec::with_capacity(3);
1238         hops.push(RouteHop {
1239                 pubkey: nodes[3].node.get_our_node_id(),
1240                 node_features: NodeFeatures::empty(),
1241                 short_channel_id: chan_4.0.contents.short_channel_id,
1242                 channel_features: ChannelFeatures::empty(),
1243                 fee_msat: 0,
1244                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1245         });
1246         hops.push(RouteHop {
1247                 pubkey: nodes[2].node.get_our_node_id(),
1248                 node_features: NodeFeatures::empty(),
1249                 short_channel_id: chan_3.0.contents.short_channel_id,
1250                 channel_features: ChannelFeatures::empty(),
1251                 fee_msat: 0,
1252                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1253         });
1254         hops.push(RouteHop {
1255                 pubkey: nodes[1].node.get_our_node_id(),
1256                 node_features: NodeFeatures::empty(),
1257                 short_channel_id: chan_2.0.contents.short_channel_id,
1258                 channel_features: ChannelFeatures::empty(),
1259                 fee_msat: 1000000,
1260                 cltv_expiry_delta: TEST_FINAL_CLTV,
1261         });
1262         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;
1263         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;
1264         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1265
1266         // Claim the rebalances...
1267         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1268         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1269
1270         // Add a duplicate new channel from 2 to 4
1271         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1272
1273         // Send some payments across both channels
1274         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1275         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1276         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1277
1278
1279         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1280         let events = nodes[0].node.get_and_clear_pending_msg_events();
1281         assert_eq!(events.len(), 0);
1282         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);
1283
1284         //TODO: Test that routes work again here as we've been notified that the channel is full
1285
1286         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1287         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1288         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1289
1290         // Close down the channels...
1291         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1292         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1293         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1294         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1295         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1296 }
1297
1298 #[test]
1299 fn holding_cell_htlc_counting() {
1300         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1301         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1302         // commitment dance rounds.
1303         let chanmon_cfgs = create_chanmon_cfgs(3);
1304         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1305         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1306         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1307         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1308         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1309         let logger = test_utils::TestLogger::new();
1310
1311         let mut payments = Vec::new();
1312         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1313                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1314                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1315                 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(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1316                 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
1317                 payments.push((payment_preimage, payment_hash));
1318         }
1319         check_added_monitors!(nodes[1], 1);
1320
1321         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1322         assert_eq!(events.len(), 1);
1323         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1324         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1325
1326         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1327         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1328         // another HTLC.
1329         let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1330         {
1331                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1332                 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(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1333                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &None), true, APIError::ChannelUnavailable { ref err },
1334                         assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1335                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1336                 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1337         }
1338
1339         // This should also be true if we try to forward a payment.
1340         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1341         {
1342                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1343                 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(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1344                 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
1345                 check_added_monitors!(nodes[0], 1);
1346         }
1347
1348         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1349         assert_eq!(events.len(), 1);
1350         let payment_event = SendEvent::from_event(events.pop().unwrap());
1351         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1352
1353         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1354         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1355         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1356         // fails), the second will process the resulting failure and fail the HTLC backward.
1357         expect_pending_htlcs_forwardable!(nodes[1]);
1358         expect_pending_htlcs_forwardable!(nodes[1]);
1359         check_added_monitors!(nodes[1], 1);
1360
1361         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1362         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1363         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1364
1365         let events = nodes[0].node.get_and_clear_pending_msg_events();
1366         assert_eq!(events.len(), 1);
1367         match events[0] {
1368                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1369                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1370                 },
1371                 _ => panic!("Unexpected event"),
1372         }
1373
1374         expect_payment_failed!(nodes[0], payment_hash_2, false);
1375
1376         // Now forward all the pending HTLCs and claim them back
1377         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1378         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1379         check_added_monitors!(nodes[2], 1);
1380
1381         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1382         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1383         check_added_monitors!(nodes[1], 1);
1384         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1385
1386         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1387         check_added_monitors!(nodes[1], 1);
1388         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1389
1390         for ref update in as_updates.update_add_htlcs.iter() {
1391                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1392         }
1393         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1394         check_added_monitors!(nodes[2], 1);
1395         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1396         check_added_monitors!(nodes[2], 1);
1397         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1398
1399         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1400         check_added_monitors!(nodes[1], 1);
1401         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1402         check_added_monitors!(nodes[1], 1);
1403         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1404
1405         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1406         check_added_monitors!(nodes[2], 1);
1407
1408         expect_pending_htlcs_forwardable!(nodes[2]);
1409
1410         let events = nodes[2].node.get_and_clear_pending_events();
1411         assert_eq!(events.len(), payments.len());
1412         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1413                 match event {
1414                         &Event::PaymentReceived { ref payment_hash, .. } => {
1415                                 assert_eq!(*payment_hash, *hash);
1416                         },
1417                         _ => panic!("Unexpected event"),
1418                 };
1419         }
1420
1421         for (preimage, _) in payments.drain(..) {
1422                 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1423         }
1424
1425         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1426 }
1427
1428 #[test]
1429 fn duplicate_htlc_test() {
1430         // Test that we accept duplicate payment_hash HTLCs across the network and that
1431         // claiming/failing them are all separate and don't affect each other
1432         let chanmon_cfgs = create_chanmon_cfgs(6);
1433         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1434         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1435         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1436
1437         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1438         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1439         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1440         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1441         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1442         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1443
1444         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1445
1446         *nodes[0].network_payment_count.borrow_mut() -= 1;
1447         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1448
1449         *nodes[0].network_payment_count.borrow_mut() -= 1;
1450         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1451
1452         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1453         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1454         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1455 }
1456
1457 #[test]
1458 fn test_duplicate_htlc_different_direction_onchain() {
1459         // Test that ChannelMonitor doesn't generate 2 preimage txn
1460         // when we have 2 HTLCs with same preimage that go across a node
1461         // in opposite directions.
1462         let chanmon_cfgs = create_chanmon_cfgs(2);
1463         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1464         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1465         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1466
1467         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1468         let logger = test_utils::TestLogger::new();
1469
1470         // balancing
1471         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1472
1473         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1474
1475         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1476         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(), None, &Vec::new(), 800_000, TEST_FINAL_CLTV, &logger).unwrap();
1477         send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1478
1479         // Provide preimage to node 0 by claiming payment
1480         nodes[0].node.claim_funds(payment_preimage, &None, 800_000);
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         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1498         connect_block(&nodes[0], &Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1499         check_added_monitors!(nodes[0], 1);
1500
1501         // Check we only broadcast 1 timeout tx
1502         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1503         let htlc_pair = if claim_txn[0].output[0].value == 800_000 / 1000 { (claim_txn[0].clone(), claim_txn[1].clone()) } else { (claim_txn[1].clone(), claim_txn[0].clone()) };
1504         assert_eq!(claim_txn.len(), 5);
1505         check_spends!(claim_txn[2], chan_1.3);
1506         check_spends!(claim_txn[3], claim_txn[2]);
1507         assert_eq!(htlc_pair.0.input.len(), 1);
1508         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1509         check_spends!(htlc_pair.0, remote_txn[0]);
1510         assert_eq!(htlc_pair.1.input.len(), 1);
1511         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1512         check_spends!(htlc_pair.1, remote_txn[0]);
1513
1514         let events = nodes[0].node.get_and_clear_pending_msg_events();
1515         assert_eq!(events.len(), 2);
1516         for e in events {
1517                 match e {
1518                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1519                         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, .. } } => {
1520                                 assert!(update_add_htlcs.is_empty());
1521                                 assert!(update_fail_htlcs.is_empty());
1522                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1523                                 assert!(update_fail_malformed_htlcs.is_empty());
1524                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1525                         },
1526                         _ => panic!("Unexpected event"),
1527                 }
1528         }
1529 }
1530
1531 #[test]
1532 fn test_basic_channel_reserve() {
1533         let chanmon_cfgs = create_chanmon_cfgs(2);
1534         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1535         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1536         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1537         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1538         let logger = test_utils::TestLogger::new();
1539
1540         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1541         let channel_reserve = chan_stat.channel_reserve_msat;
1542
1543         // The 2* and +1 are for the fee spike reserve.
1544         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
1545         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1546         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1547         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1548         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(), None, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1549         let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
1550         match err {
1551                 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1552                         match &fails[0] {
1553                                 &APIError::ChannelUnavailable{ref err} =>
1554                                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1555                                 _ => panic!("Unexpected error variant"),
1556                         }
1557                 },
1558                 _ => panic!("Unexpected error variant"),
1559         }
1560         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1561         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);
1562
1563         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send, max_can_send);
1564 }
1565
1566 #[test]
1567 fn test_fee_spike_violation_fails_htlc() {
1568         let chanmon_cfgs = create_chanmon_cfgs(2);
1569         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1570         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1571         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1572         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1573         let logger = test_utils::TestLogger::new();
1574
1575         macro_rules! get_route_and_payment_hash {
1576                 ($recv_value: expr) => {{
1577                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1578                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler.network_graph.read().unwrap();
1579                         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1580                         (route, payment_hash, payment_preimage)
1581                 }}
1582         }
1583
1584         let (route, payment_hash, _) = get_route_and_payment_hash!(3460001);
1585         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1586         let secp_ctx = Secp256k1::new();
1587         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1588
1589         let cur_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1590
1591         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1592         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &None, cur_height).unwrap();
1593         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1594         let msg = msgs::UpdateAddHTLC {
1595                 channel_id: chan.2,
1596                 htlc_id: 0,
1597                 amount_msat: htlc_msat,
1598                 payment_hash: payment_hash,
1599                 cltv_expiry: htlc_cltv,
1600                 onion_routing_packet: onion_packet,
1601         };
1602
1603         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1604
1605         // Now manually create the commitment_signed message corresponding to the update_add
1606         // nodes[0] just sent. In the code for construction of this message, "local" refers
1607         // to the sender of the message, and "remote" refers to the receiver.
1608
1609         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1610
1611         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1612
1613         // Get the EnforcingChannelKeys for each channel, which will be used to (1) get the keys
1614         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1615         let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point) = {
1616                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1617                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1618                 let chan_keys = local_chan.get_keys();
1619                 let pubkeys = chan_keys.pubkeys();
1620                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1621                  chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1622                  chan_keys.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx))
1623         };
1624         let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point) = {
1625                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1626                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1627                 let chan_keys = remote_chan.get_keys();
1628                 let pubkeys = chan_keys.pubkeys();
1629                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1630                  chan_keys.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx))
1631         };
1632
1633         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1634         let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1635                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1636
1637         // Build the remote commitment transaction so we can sign it, and then later use the
1638         // signature for the commitment_signed message.
1639         let local_chan_balance = 1313;
1640
1641         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1642                 offered: false,
1643                 amount_msat: 3460001,
1644                 cltv_expiry: htlc_cltv,
1645                 payment_hash,
1646                 transaction_output_index: Some(1),
1647         };
1648
1649         let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1650
1651         let res = {
1652                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1653                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1654                 let local_chan_keys = local_chan.get_keys();
1655                 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1656                         commitment_number,
1657                         95000,
1658                         local_chan_balance,
1659                         commit_tx_keys.clone(),
1660                         feerate_per_kw,
1661                         &mut vec![(accepted_htlc_info, ())],
1662                         &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1663                 );
1664                 local_chan_keys.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1665         };
1666
1667         let commit_signed_msg = msgs::CommitmentSigned {
1668                 channel_id: chan.2,
1669                 signature: res.0,
1670                 htlc_signatures: res.1
1671         };
1672
1673         // Send the commitment_signed message to the nodes[1].
1674         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1675         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1676
1677         // Send the RAA to nodes[1].
1678         let raa_msg = msgs::RevokeAndACK {
1679                 channel_id: chan.2,
1680                 per_commitment_secret: local_secret,
1681                 next_per_commitment_point: next_local_point
1682         };
1683         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1684
1685         let events = nodes[1].node.get_and_clear_pending_msg_events();
1686         assert_eq!(events.len(), 1);
1687         // Make sure the HTLC failed in the way we expect.
1688         match events[0] {
1689                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1690                         assert_eq!(update_fail_htlcs.len(), 1);
1691                         update_fail_htlcs[0].clone()
1692                 },
1693                 _ => panic!("Unexpected event"),
1694         };
1695         nodes[1].logger.assert_log("lightning::ln::channel".to_string(), "Attempting to fail HTLC due to fee spike buffer violation".to_string(), 1);
1696
1697         check_added_monitors!(nodes[1], 2);
1698 }
1699
1700 #[test]
1701 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1702         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1703         // Set the fee rate for the channel very high, to the point where the fundee
1704         // sending any above-dust amount would result in a channel reserve violation.
1705         // In this test we check that we would be prevented from sending an HTLC in
1706         // this situation.
1707         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1708         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1709         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1710         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1711         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1712         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1713         let logger = test_utils::TestLogger::new();
1714
1715         macro_rules! get_route_and_payment_hash {
1716                 ($recv_value: expr) => {{
1717                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1718                         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1719                         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.first().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1720                         (route, payment_hash, payment_preimage)
1721                 }}
1722         }
1723
1724         let (route, our_payment_hash, _) = get_route_and_payment_hash!(4843000);
1725         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1726                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1727         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1728         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);
1729 }
1730
1731 #[test]
1732 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1733         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1734         // Set the fee rate for the channel very high, to the point where the funder
1735         // receiving 1 update_add_htlc would result in them closing the channel due
1736         // to channel reserve violation. This close could also happen if the fee went
1737         // up a more realistic amount, but many HTLCs were outstanding at the time of
1738         // the update_add_htlc.
1739         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1740         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1741         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1742         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1743         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1744         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1745         let logger = test_utils::TestLogger::new();
1746
1747         macro_rules! get_route_and_payment_hash {
1748                 ($recv_value: expr) => {{
1749                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1750                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1751                         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.first().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1752                         (route, payment_hash, payment_preimage)
1753                 }}
1754         }
1755
1756         let (route, payment_hash, _) = get_route_and_payment_hash!(1000);
1757         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1758         let secp_ctx = Secp256k1::new();
1759         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1760         let cur_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1761         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1762         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &None, cur_height).unwrap();
1763         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1764         let msg = msgs::UpdateAddHTLC {
1765                 channel_id: chan.2,
1766                 htlc_id: 1,
1767                 amount_msat: htlc_msat + 1,
1768                 payment_hash: payment_hash,
1769                 cltv_expiry: htlc_cltv,
1770                 onion_routing_packet: onion_packet,
1771         };
1772
1773         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1774         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1775         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);
1776         assert_eq!(nodes[0].node.list_channels().len(), 0);
1777         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1778         assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1779         check_added_monitors!(nodes[0], 1);
1780 }
1781
1782 #[test]
1783 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1784         // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1785         // calculating our commitment transaction fee (this was previously broken).
1786         let chanmon_cfgs = create_chanmon_cfgs(2);
1787         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1788         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1789         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1790
1791         // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1792         // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1793         // transaction fee with 0 HTLCs (183 sats)).
1794         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98817000, InitFeatures::known(), InitFeatures::known());
1795
1796         let dust_amt = 546000; // Dust amount
1797         // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1798         // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1799         // commitment transaction fee.
1800         let (_, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1801 }
1802
1803 #[test]
1804 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1805         // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1806         // calculating our counterparty's commitment transaction fee (this was previously broken).
1807         let chanmon_cfgs = create_chanmon_cfgs(2);
1808         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1809         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1810         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1811         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1812
1813         let payment_amt = 46000; // Dust amount
1814         // In the previous code, these first four payments would succeed.
1815         let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1816         let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1817         let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1818         let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1819
1820         // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1821         let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1822         let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1823         let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1824         let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1825         let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1826
1827         // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1828         // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1829         // transaction fee and therefore perceived this next payment as a channel reserve violation.
1830         let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1831 }
1832
1833 #[test]
1834 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1835         let chanmon_cfgs = create_chanmon_cfgs(3);
1836         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1837         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1838         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1839         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1840         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1841         let logger = test_utils::TestLogger::new();
1842
1843         macro_rules! get_route_and_payment_hash {
1844                 ($recv_value: expr) => {{
1845                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1846                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1847                         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(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1848                         (route, payment_hash, payment_preimage)
1849                 }}
1850         }
1851
1852         let feemsat = 239;
1853         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1854         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1855         let feerate = get_feerate!(nodes[0], chan.2);
1856
1857         // Add a 2* and +1 for the fee spike reserve.
1858         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1859         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;
1860         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1861
1862         // Add a pending HTLC.
1863         let (route_1, our_payment_hash_1, _) = get_route_and_payment_hash!(amt_msat_1);
1864         let payment_event_1 = {
1865                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1866                 check_added_monitors!(nodes[0], 1);
1867
1868                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1869                 assert_eq!(events.len(), 1);
1870                 SendEvent::from_event(events.remove(0))
1871         };
1872         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1873
1874         // Attempt to trigger a channel reserve violation --> payment failure.
1875         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1876         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;
1877         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1878         let (route_2, _, _) = get_route_and_payment_hash!(amt_msat_2);
1879
1880         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1881         let secp_ctx = Secp256k1::new();
1882         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1883         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1884         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1885         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1886         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1887         let msg = msgs::UpdateAddHTLC {
1888                 channel_id: chan.2,
1889                 htlc_id: 1,
1890                 amount_msat: htlc_msat + 1,
1891                 payment_hash: our_payment_hash_1,
1892                 cltv_expiry: htlc_cltv,
1893                 onion_routing_packet: onion_packet,
1894         };
1895
1896         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1897         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1898         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1899         assert_eq!(nodes[1].node.list_channels().len(), 1);
1900         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1901         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1902         check_added_monitors!(nodes[1], 1);
1903 }
1904
1905 #[test]
1906 fn test_inbound_outbound_capacity_is_not_zero() {
1907         let chanmon_cfgs = create_chanmon_cfgs(2);
1908         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1909         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1910         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1911         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1912         let channels0 = node_chanmgrs[0].list_channels();
1913         let channels1 = node_chanmgrs[1].list_channels();
1914         assert_eq!(channels0.len(), 1);
1915         assert_eq!(channels1.len(), 1);
1916
1917         assert_eq!(channels0[0].inbound_capacity_msat, 95000000);
1918         assert_eq!(channels1[0].outbound_capacity_msat, 95000000);
1919
1920         assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000);
1921         assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000);
1922 }
1923
1924 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1925         (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1926 }
1927
1928 #[test]
1929 fn test_channel_reserve_holding_cell_htlcs() {
1930         let chanmon_cfgs = create_chanmon_cfgs(3);
1931         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1932         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1933         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1934         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1935         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1936         let logger = test_utils::TestLogger::new();
1937
1938         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1939         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1940
1941         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1942         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1943
1944         macro_rules! get_route_and_payment_hash {
1945                 ($recv_value: expr) => {{
1946                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1947                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1948                         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(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1949                         (route, payment_hash, payment_preimage)
1950                 }}
1951         }
1952
1953         macro_rules! expect_forward {
1954                 ($node: expr) => {{
1955                         let mut events = $node.node.get_and_clear_pending_msg_events();
1956                         assert_eq!(events.len(), 1);
1957                         check_added_monitors!($node, 1);
1958                         let payment_event = SendEvent::from_event(events.remove(0));
1959                         payment_event
1960                 }}
1961         }
1962
1963         let feemsat = 239; // somehow we know?
1964         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1965         let feerate = get_feerate!(nodes[0], chan_1.2);
1966
1967         let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1968
1969         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1970         {
1971                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1972                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1973                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1974                         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)));
1975                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1976                 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);
1977         }
1978
1979         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1980         // nodes[0]'s wealth
1981         loop {
1982                 let amt_msat = recv_value_0 + total_fee_msat;
1983                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1984                 // Also, ensure that each payment has enough to be over the dust limit to
1985                 // ensure it'll be included in each commit tx fee calculation.
1986                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1987                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1988                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1989                         break;
1990                 }
1991                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1992
1993                 let (stat01_, stat11_, stat12_, stat22_) = (
1994                         get_channel_value_stat!(nodes[0], chan_1.2),
1995                         get_channel_value_stat!(nodes[1], chan_1.2),
1996                         get_channel_value_stat!(nodes[1], chan_2.2),
1997                         get_channel_value_stat!(nodes[2], chan_2.2),
1998                 );
1999
2000                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
2001                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
2002                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
2003                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
2004                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
2005         }
2006
2007         // adding pending output.
2008         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
2009         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
2010         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
2011         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
2012         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
2013         // cases where 1 msat over X amount will cause a payment failure, but anything less than
2014         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
2015         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
2016         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
2017         // policy.
2018         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
2019         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
2020         let amt_msat_1 = recv_value_1 + total_fee_msat;
2021
2022         let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
2023         let payment_event_1 = {
2024                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
2025                 check_added_monitors!(nodes[0], 1);
2026
2027                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2028                 assert_eq!(events.len(), 1);
2029                 SendEvent::from_event(events.remove(0))
2030         };
2031         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
2032
2033         // channel reserve test with htlc pending output > 0
2034         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
2035         {
2036                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
2037                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
2038                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2039                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2040         }
2041
2042         // split the rest to test holding cell
2043         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
2044         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2045         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2046         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2047         {
2048                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2049                 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);
2050         }
2051
2052         // now see if they go through on both sides
2053         let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
2054         // but this will stuck in the holding cell
2055         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &None).unwrap();
2056         check_added_monitors!(nodes[0], 0);
2057         let events = nodes[0].node.get_and_clear_pending_events();
2058         assert_eq!(events.len(), 0);
2059
2060         // test with outbound holding cell amount > 0
2061         {
2062                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
2063                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
2064                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2065                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2066                 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);
2067         }
2068
2069         let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
2070         // this will also stuck in the holding cell
2071         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &None).unwrap();
2072         check_added_monitors!(nodes[0], 0);
2073         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2074         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2075
2076         // flush the pending htlc
2077         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2078         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2079         check_added_monitors!(nodes[1], 1);
2080
2081         // the pending htlc should be promoted to committed
2082         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2083         check_added_monitors!(nodes[0], 1);
2084         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2085
2086         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2087         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2088         // No commitment_signed so get_event_msg's assert(len == 1) passes
2089         check_added_monitors!(nodes[0], 1);
2090
2091         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2092         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2093         check_added_monitors!(nodes[1], 1);
2094
2095         expect_pending_htlcs_forwardable!(nodes[1]);
2096
2097         let ref payment_event_11 = expect_forward!(nodes[1]);
2098         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2099         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2100
2101         expect_pending_htlcs_forwardable!(nodes[2]);
2102         expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
2103
2104         // flush the htlcs in the holding cell
2105         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2106         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2107         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2108         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2109         expect_pending_htlcs_forwardable!(nodes[1]);
2110
2111         let ref payment_event_3 = expect_forward!(nodes[1]);
2112         assert_eq!(payment_event_3.msgs.len(), 2);
2113         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2114         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2115
2116         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2117         expect_pending_htlcs_forwardable!(nodes[2]);
2118
2119         let events = nodes[2].node.get_and_clear_pending_events();
2120         assert_eq!(events.len(), 2);
2121         match events[0] {
2122                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2123                         assert_eq!(our_payment_hash_21, *payment_hash);
2124                         assert_eq!(*payment_secret, None);
2125                         assert_eq!(recv_value_21, amt);
2126                 },
2127                 _ => panic!("Unexpected event"),
2128         }
2129         match events[1] {
2130                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2131                         assert_eq!(our_payment_hash_22, *payment_hash);
2132                         assert_eq!(None, *payment_secret);
2133                         assert_eq!(recv_value_22, amt);
2134                 },
2135                 _ => panic!("Unexpected event"),
2136         }
2137
2138         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
2139         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
2140         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
2141
2142         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2143         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2144         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3, recv_value_3);
2145
2146         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2147         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);
2148         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2149         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2150         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2151
2152         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2153         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2154 }
2155
2156 #[test]
2157 fn channel_reserve_in_flight_removes() {
2158         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2159         // can send to its counterparty, but due to update ordering, the other side may not yet have
2160         // considered those HTLCs fully removed.
2161         // This tests that we don't count HTLCs which will not be included in the next remote
2162         // commitment transaction towards the reserve value (as it implies no commitment transaction
2163         // will be generated which violates the remote reserve value).
2164         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2165         // To test this we:
2166         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2167         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2168         //    you only consider the value of the first HTLC, it may not),
2169         //  * start routing a third HTLC from A to B,
2170         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2171         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2172         //  * deliver the first fulfill from B
2173         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2174         //    claim,
2175         //  * deliver A's response CS and RAA.
2176         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2177         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
2178         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2179         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2180         let chanmon_cfgs = create_chanmon_cfgs(2);
2181         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2182         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2183         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2184         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2185         let logger = test_utils::TestLogger::new();
2186
2187         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2188         // Route the first two HTLCs.
2189         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2190         let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2191
2192         // Start routing the third HTLC (this is just used to get everyone in the right state).
2193         let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
2194         let send_1 = {
2195                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2196                 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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
2197                 nodes[0].node.send_payment(&route, payment_hash_3, &None).unwrap();
2198                 check_added_monitors!(nodes[0], 1);
2199                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2200                 assert_eq!(events.len(), 1);
2201                 SendEvent::from_event(events.remove(0))
2202         };
2203
2204         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2205         // initial fulfill/CS.
2206         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
2207         check_added_monitors!(nodes[1], 1);
2208         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2209
2210         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2211         // remove the second HTLC when we send the HTLC back from B to A.
2212         assert!(nodes[1].node.claim_funds(payment_preimage_2, &None, 20000));
2213         check_added_monitors!(nodes[1], 1);
2214         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2215
2216         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2217         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2218         check_added_monitors!(nodes[0], 1);
2219         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2220         expect_payment_sent!(nodes[0], payment_preimage_1);
2221
2222         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2223         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2224         check_added_monitors!(nodes[1], 1);
2225         // B is already AwaitingRAA, so cant generate a CS here
2226         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2227
2228         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2229         check_added_monitors!(nodes[1], 1);
2230         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2231
2232         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2233         check_added_monitors!(nodes[0], 1);
2234         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2235
2236         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2237         check_added_monitors!(nodes[1], 1);
2238         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2239
2240         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2241         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2242         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2243         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2244         // on-chain as necessary).
2245         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2246         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2247         check_added_monitors!(nodes[0], 1);
2248         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2249         expect_payment_sent!(nodes[0], payment_preimage_2);
2250
2251         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2252         check_added_monitors!(nodes[1], 1);
2253         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2254
2255         expect_pending_htlcs_forwardable!(nodes[1]);
2256         expect_payment_received!(nodes[1], payment_hash_3, 100000);
2257
2258         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2259         // resolve the second HTLC from A's point of view.
2260         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2261         check_added_monitors!(nodes[0], 1);
2262         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2263
2264         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2265         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2266         let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
2267         let send_2 = {
2268                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2269                 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(), None, &[], 10000, TEST_FINAL_CLTV, &logger).unwrap();
2270                 nodes[1].node.send_payment(&route, payment_hash_4, &None).unwrap();
2271                 check_added_monitors!(nodes[1], 1);
2272                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2273                 assert_eq!(events.len(), 1);
2274                 SendEvent::from_event(events.remove(0))
2275         };
2276
2277         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2278         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2279         check_added_monitors!(nodes[0], 1);
2280         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2281
2282         // Now just resolve all the outstanding messages/HTLCs for completeness...
2283
2284         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2285         check_added_monitors!(nodes[1], 1);
2286         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2287
2288         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2289         check_added_monitors!(nodes[1], 1);
2290
2291         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2292         check_added_monitors!(nodes[0], 1);
2293         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2294
2295         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2296         check_added_monitors!(nodes[1], 1);
2297         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2298
2299         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2300         check_added_monitors!(nodes[0], 1);
2301
2302         expect_pending_htlcs_forwardable!(nodes[0]);
2303         expect_payment_received!(nodes[0], payment_hash_4, 10000);
2304
2305         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
2306         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
2307 }
2308
2309 #[test]
2310 fn channel_monitor_network_test() {
2311         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2312         // tests that ChannelMonitor is able to recover from various states.
2313         let chanmon_cfgs = create_chanmon_cfgs(5);
2314         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2315         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2316         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2317
2318         // Create some initial channels
2319         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2320         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2321         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2322         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2323
2324         // Rebalance the network a bit by relaying one payment through all the channels...
2325         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2326         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2327         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2328         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2329
2330         // Simple case with no pending HTLCs:
2331         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2332         check_added_monitors!(nodes[1], 1);
2333         {
2334                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2335                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2336                 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2337                 check_added_monitors!(nodes[0], 1);
2338                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2339         }
2340         get_announce_close_broadcast_events(&nodes, 0, 1);
2341         assert_eq!(nodes[0].node.list_channels().len(), 0);
2342         assert_eq!(nodes[1].node.list_channels().len(), 1);
2343
2344         // One pending HTLC is discarded by the force-close:
2345         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2346
2347         // Simple case of one pending HTLC to HTLC-Timeout
2348         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2349         check_added_monitors!(nodes[1], 1);
2350         {
2351                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2352                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2353                 connect_block(&nodes[2], &Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2354                 check_added_monitors!(nodes[2], 1);
2355                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2356         }
2357         get_announce_close_broadcast_events(&nodes, 1, 2);
2358         assert_eq!(nodes[1].node.list_channels().len(), 0);
2359         assert_eq!(nodes[2].node.list_channels().len(), 1);
2360
2361         macro_rules! claim_funds {
2362                 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
2363                         {
2364                                 assert!($node.node.claim_funds($preimage, &None, $amount));
2365                                 check_added_monitors!($node, 1);
2366
2367                                 let events = $node.node.get_and_clear_pending_msg_events();
2368                                 assert_eq!(events.len(), 1);
2369                                 match events[0] {
2370                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2371                                                 assert!(update_add_htlcs.is_empty());
2372                                                 assert!(update_fail_htlcs.is_empty());
2373                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2374                                         },
2375                                         _ => panic!("Unexpected event"),
2376                                 };
2377                         }
2378                 }
2379         }
2380
2381         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2382         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2383         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2384         check_added_monitors!(nodes[2], 1);
2385         let node2_commitment_txid;
2386         {
2387                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2388                 node2_commitment_txid = node_txn[0].txid();
2389
2390                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2391                 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
2392
2393                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2394                 connect_block(&nodes[3], &Block { header, txdata: vec![node_txn[0].clone()] }, 1);
2395                 check_added_monitors!(nodes[3], 1);
2396
2397                 check_preimage_claim(&nodes[3], &node_txn);
2398         }
2399         get_announce_close_broadcast_events(&nodes, 2, 3);
2400         assert_eq!(nodes[2].node.list_channels().len(), 0);
2401         assert_eq!(nodes[3].node.list_channels().len(), 1);
2402
2403         { // Cheat and reset nodes[4]'s height to 1
2404                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2405                 connect_block(&nodes[4], &Block { header, txdata: vec![] }, 1);
2406         }
2407
2408         assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
2409         assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
2410         // One pending HTLC to time out:
2411         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2412         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2413         // buffer space).
2414
2415         let (close_chan_update_1, close_chan_update_2) = {
2416                 let mut block = Block {
2417                         header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2418                         txdata: vec![],
2419                 };
2420                 connect_block(&nodes[3], &block, 2);
2421                 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
2422                         block = Block {
2423                                 header: BlockHeader { version: 0x20000000, prev_blockhash: block.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2424                                 txdata: vec![],
2425                         };
2426                         connect_block(&nodes[3], &block, i);
2427                 }
2428                 let events = nodes[3].node.get_and_clear_pending_msg_events();
2429                 assert_eq!(events.len(), 1);
2430                 let close_chan_update_1 = match events[0] {
2431                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2432                                 msg.clone()
2433                         },
2434                         _ => panic!("Unexpected event"),
2435                 };
2436                 check_added_monitors!(nodes[3], 1);
2437
2438                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2439                 {
2440                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2441                         node_txn.retain(|tx| {
2442                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2443                                         false
2444                                 } else { true }
2445                         });
2446                 }
2447
2448                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2449
2450                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2451                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2452
2453                 block = Block {
2454                         header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2455                         txdata: vec![],
2456                 };
2457
2458                 connect_block(&nodes[4], &block, 2);
2459                 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
2460                         block = Block {
2461                                 header: BlockHeader { version: 0x20000000, prev_blockhash: block.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2462                                 txdata: vec![],
2463                         };
2464                         connect_block(&nodes[4], &block, i);
2465                 }
2466                 let events = nodes[4].node.get_and_clear_pending_msg_events();
2467                 assert_eq!(events.len(), 1);
2468                 let close_chan_update_2 = match events[0] {
2469                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2470                                 msg.clone()
2471                         },
2472                         _ => panic!("Unexpected event"),
2473                 };
2474                 check_added_monitors!(nodes[4], 1);
2475                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2476
2477                 block = Block {
2478                         header: BlockHeader { version: 0x20000000, prev_blockhash: block.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2479                         txdata: vec![node_txn[0].clone()],
2480                 };
2481                 connect_block(&nodes[4], &block, TEST_FINAL_CLTV - 5);
2482
2483                 check_preimage_claim(&nodes[4], &node_txn);
2484                 (close_chan_update_1, close_chan_update_2)
2485         };
2486         nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2487         nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2488         assert_eq!(nodes[3].node.list_channels().len(), 0);
2489         assert_eq!(nodes[4].node.list_channels().len(), 0);
2490 }
2491
2492 #[test]
2493 fn test_justice_tx() {
2494         // Test justice txn built on revoked HTLC-Success tx, against both sides
2495         let mut alice_config = UserConfig::default();
2496         alice_config.channel_options.announced_channel = true;
2497         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2498         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2499         let mut bob_config = UserConfig::default();
2500         bob_config.channel_options.announced_channel = true;
2501         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2502         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2503         let user_cfgs = [Some(alice_config), Some(bob_config)];
2504         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2505         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2506         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2507         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2508         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2509         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2510         // Create some new channels:
2511         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2512
2513         // A pending HTLC which will be revoked:
2514         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2515         // Get the will-be-revoked local txn from nodes[0]
2516         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2517         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2518         assert_eq!(revoked_local_txn[0].input.len(), 1);
2519         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2520         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2521         assert_eq!(revoked_local_txn[1].input.len(), 1);
2522         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2523         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2524         // Revoke the old state
2525         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2526
2527         {
2528                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2529                 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2530                 {
2531                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2532                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2533                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2534
2535                         check_spends!(node_txn[0], revoked_local_txn[0]);
2536                         node_txn.swap_remove(0);
2537                         node_txn.truncate(1);
2538                 }
2539                 check_added_monitors!(nodes[1], 1);
2540                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2541
2542                 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2543                 // Verify broadcast of revoked HTLC-timeout
2544                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2545                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2546                 check_added_monitors!(nodes[0], 1);
2547                 // Broadcast revoked HTLC-timeout on node 1
2548                 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2549                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2550         }
2551         get_announce_close_broadcast_events(&nodes, 0, 1);
2552
2553         assert_eq!(nodes[0].node.list_channels().len(), 0);
2554         assert_eq!(nodes[1].node.list_channels().len(), 0);
2555
2556         // We test justice_tx build by A on B's revoked HTLC-Success tx
2557         // Create some new channels:
2558         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2559         {
2560                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2561                 node_txn.clear();
2562         }
2563
2564         // A pending HTLC which will be revoked:
2565         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2566         // Get the will-be-revoked local txn from B
2567         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2568         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2569         assert_eq!(revoked_local_txn[0].input.len(), 1);
2570         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2571         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2572         // Revoke the old state
2573         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2574         {
2575                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2576                 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2577                 {
2578                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2579                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2580                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2581
2582                         check_spends!(node_txn[0], revoked_local_txn[0]);
2583                         node_txn.swap_remove(0);
2584                 }
2585                 check_added_monitors!(nodes[0], 1);
2586                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2587
2588                 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2589                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2590                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2591                 check_added_monitors!(nodes[1], 1);
2592                 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2593                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2594         }
2595         get_announce_close_broadcast_events(&nodes, 0, 1);
2596         assert_eq!(nodes[0].node.list_channels().len(), 0);
2597         assert_eq!(nodes[1].node.list_channels().len(), 0);
2598 }
2599
2600 #[test]
2601 fn revoked_output_claim() {
2602         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2603         // transaction is broadcast by its counterparty
2604         let chanmon_cfgs = create_chanmon_cfgs(2);
2605         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2606         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2607         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2608         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2609         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2610         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2611         assert_eq!(revoked_local_txn.len(), 1);
2612         // Only output is the full channel value back to nodes[0]:
2613         assert_eq!(revoked_local_txn[0].output.len(), 1);
2614         // Send a payment through, updating everyone's latest commitment txn
2615         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2616
2617         // Inform nodes[1] that nodes[0] broadcast a stale tx
2618         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2619         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2620         check_added_monitors!(nodes[1], 1);
2621         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2622         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2623
2624         check_spends!(node_txn[0], revoked_local_txn[0]);
2625         check_spends!(node_txn[1], chan_1.3);
2626
2627         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2628         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2629         get_announce_close_broadcast_events(&nodes, 0, 1);
2630         check_added_monitors!(nodes[0], 1)
2631 }
2632
2633 #[test]
2634 fn claim_htlc_outputs_shared_tx() {
2635         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2636         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2637         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2638         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2639         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2640         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2641
2642         // Create some new channel:
2643         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2644
2645         // Rebalance the network to generate htlc in the two directions
2646         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2647         // 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
2648         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2649         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2650
2651         // Get the will-be-revoked local txn from node[0]
2652         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2653         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2654         assert_eq!(revoked_local_txn[0].input.len(), 1);
2655         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2656         assert_eq!(revoked_local_txn[1].input.len(), 1);
2657         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2658         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2659         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2660
2661         //Revoke the old state
2662         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2663
2664         {
2665                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2666                 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2667                 check_added_monitors!(nodes[0], 1);
2668                 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2669                 check_added_monitors!(nodes[1], 1);
2670                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
2671                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2672
2673                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2674                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2675
2676                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2677                 check_spends!(node_txn[0], revoked_local_txn[0]);
2678
2679                 let mut witness_lens = BTreeSet::new();
2680                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2681                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2682                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2683                 assert_eq!(witness_lens.len(), 3);
2684                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2685                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2686                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2687
2688                 // Next nodes[1] broadcasts its current local tx state:
2689                 assert_eq!(node_txn[1].input.len(), 1);
2690                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2691
2692                 assert_eq!(node_txn[2].input.len(), 1);
2693                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2694                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2695                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2696                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2697                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2698         }
2699         get_announce_close_broadcast_events(&nodes, 0, 1);
2700         assert_eq!(nodes[0].node.list_channels().len(), 0);
2701         assert_eq!(nodes[1].node.list_channels().len(), 0);
2702 }
2703
2704 #[test]
2705 fn claim_htlc_outputs_single_tx() {
2706         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2707         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2708         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2709         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2710         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2711         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2712
2713         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2714
2715         // Rebalance the network to generate htlc in the two directions
2716         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2717         // 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
2718         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2719         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2720         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2721
2722         // Get the will-be-revoked local txn from node[0]
2723         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2724
2725         //Revoke the old state
2726         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2727
2728         {
2729                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2730                 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2731                 check_added_monitors!(nodes[0], 1);
2732                 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2733                 check_added_monitors!(nodes[1], 1);
2734                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2735
2736                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 200, true, header.block_hash());
2737                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2738
2739                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2740                 assert_eq!(node_txn.len(), 9);
2741                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2742                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2743                 // 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)
2744                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2745
2746                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2747                 assert_eq!(node_txn[2].input.len(), 1);
2748                 check_spends!(node_txn[2], chan_1.3);
2749                 assert_eq!(node_txn[3].input.len(), 1);
2750                 let witness_script = node_txn[3].input[0].witness.last().unwrap();
2751                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2752                 check_spends!(node_txn[3], node_txn[2]);
2753
2754                 // Justice transactions are indices 1-2-4
2755                 assert_eq!(node_txn[0].input.len(), 1);
2756                 assert_eq!(node_txn[1].input.len(), 1);
2757                 assert_eq!(node_txn[4].input.len(), 1);
2758
2759                 check_spends!(node_txn[0], revoked_local_txn[0]);
2760                 check_spends!(node_txn[1], revoked_local_txn[0]);
2761                 check_spends!(node_txn[4], revoked_local_txn[0]);
2762
2763                 let mut witness_lens = BTreeSet::new();
2764                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2765                 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2766                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2767                 assert_eq!(witness_lens.len(), 3);
2768                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2769                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2770                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2771         }
2772         get_announce_close_broadcast_events(&nodes, 0, 1);
2773         assert_eq!(nodes[0].node.list_channels().len(), 0);
2774         assert_eq!(nodes[1].node.list_channels().len(), 0);
2775 }
2776
2777 #[test]
2778 fn test_htlc_on_chain_success() {
2779         // Test that in case of a unilateral close onchain, we detect the state of output and pass
2780         // the preimage backward accordingly. So here we test that ChannelManager is
2781         // broadcasting the right event to other nodes in payment path.
2782         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2783         // A --------------------> B ----------------------> C (preimage)
2784         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2785         // commitment transaction was broadcast.
2786         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2787         // towards B.
2788         // B should be able to claim via preimage if A then broadcasts its local tx.
2789         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2790         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2791         // PaymentSent event).
2792
2793         let chanmon_cfgs = create_chanmon_cfgs(3);
2794         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2795         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2796         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2797
2798         // Create some initial channels
2799         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2800         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2801
2802         // Rebalance the network a bit by relaying one payment through all the channels...
2803         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2804         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2805
2806         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2807         let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2808         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2809
2810         // Broadcast legit commitment tx from C on B's chain
2811         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2812         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2813         assert_eq!(commitment_tx.len(), 1);
2814         check_spends!(commitment_tx[0], chan_2.3);
2815         nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2816         nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2817         check_added_monitors!(nodes[2], 2);
2818         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2819         assert!(updates.update_add_htlcs.is_empty());
2820         assert!(updates.update_fail_htlcs.is_empty());
2821         assert!(updates.update_fail_malformed_htlcs.is_empty());
2822         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2823
2824         connect_block(&nodes[2], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2825         check_closed_broadcast!(nodes[2], false);
2826         check_added_monitors!(nodes[2], 1);
2827         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)
2828         assert_eq!(node_txn.len(), 5);
2829         assert_eq!(node_txn[0], node_txn[3]);
2830         assert_eq!(node_txn[1], node_txn[4]);
2831         assert_eq!(node_txn[2], commitment_tx[0]);
2832         check_spends!(node_txn[0], commitment_tx[0]);
2833         check_spends!(node_txn[1], commitment_tx[0]);
2834         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2835         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2836         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2837         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2838         assert_eq!(node_txn[0].lock_time, 0);
2839         assert_eq!(node_txn[1].lock_time, 0);
2840
2841         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2842         connect_block(&nodes[1], &Block { header, txdata: node_txn}, 1);
2843         {
2844                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2845                 assert_eq!(added_monitors.len(), 1);
2846                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2847                 added_monitors.clear();
2848         }
2849         let events = nodes[1].node.get_and_clear_pending_msg_events();
2850         {
2851                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2852                 assert_eq!(added_monitors.len(), 2);
2853                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2854                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2855                 added_monitors.clear();
2856         }
2857         assert_eq!(events.len(), 2);
2858         match events[0] {
2859                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2860                 _ => panic!("Unexpected event"),
2861         }
2862         match events[1] {
2863                 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, .. } } => {
2864                         assert!(update_add_htlcs.is_empty());
2865                         assert!(update_fail_htlcs.is_empty());
2866                         assert_eq!(update_fulfill_htlcs.len(), 1);
2867                         assert!(update_fail_malformed_htlcs.is_empty());
2868                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2869                 },
2870                 _ => panic!("Unexpected event"),
2871         };
2872         macro_rules! check_tx_local_broadcast {
2873                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2874                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2875                         assert_eq!(node_txn.len(), 5);
2876                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2877                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2878                         check_spends!(node_txn[0], $commitment_tx);
2879                         check_spends!(node_txn[1], $commitment_tx);
2880                         assert_ne!(node_txn[0].lock_time, 0);
2881                         assert_ne!(node_txn[1].lock_time, 0);
2882                         if $htlc_offered {
2883                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2884                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2885                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2886                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2887                         } else {
2888                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2889                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2890                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2891                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2892                         }
2893                         check_spends!(node_txn[2], $chan_tx);
2894                         check_spends!(node_txn[3], node_txn[2]);
2895                         check_spends!(node_txn[4], node_txn[2]);
2896                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2897                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2898                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2899                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2900                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2901                         assert_ne!(node_txn[3].lock_time, 0);
2902                         assert_ne!(node_txn[4].lock_time, 0);
2903                         node_txn.clear();
2904                 } }
2905         }
2906         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2907         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2908         // timeout-claim of the output that nodes[2] just claimed via success.
2909         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2910
2911         // Broadcast legit commitment tx from A on B's chain
2912         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2913         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2914         check_spends!(commitment_tx[0], chan_1.3);
2915         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2916         check_closed_broadcast!(nodes[1], false);
2917         check_added_monitors!(nodes[1], 1);
2918         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2919         assert_eq!(node_txn.len(), 4);
2920         check_spends!(node_txn[0], commitment_tx[0]);
2921         assert_eq!(node_txn[0].input.len(), 2);
2922         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2923         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2924         assert_eq!(node_txn[0].lock_time, 0);
2925         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2926         check_spends!(node_txn[1], chan_1.3);
2927         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2928         check_spends!(node_txn[2], node_txn[1]);
2929         check_spends!(node_txn[3], node_txn[1]);
2930         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2931         // we already checked the same situation with A.
2932
2933         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2934         connect_block(&nodes[0], &Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2935         check_closed_broadcast!(nodes[0], false);
2936         check_added_monitors!(nodes[0], 1);
2937         let events = nodes[0].node.get_and_clear_pending_events();
2938         assert_eq!(events.len(), 2);
2939         let mut first_claimed = false;
2940         for event in events {
2941                 match event {
2942                         Event::PaymentSent { payment_preimage } => {
2943                                 if payment_preimage == our_payment_preimage {
2944                                         assert!(!first_claimed);
2945                                         first_claimed = true;
2946                                 } else {
2947                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2948                                 }
2949                         },
2950                         _ => panic!("Unexpected event"),
2951                 }
2952         }
2953         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2954 }
2955
2956 #[test]
2957 fn test_htlc_on_chain_timeout() {
2958         // Test that in case of a unilateral close onchain, we detect the state of output and
2959         // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2960         // broadcasting the right event to other nodes in payment path.
2961         // A ------------------> B ----------------------> C (timeout)
2962         //    B's commitment tx                 C's commitment tx
2963         //            \                                  \
2964         //         B's HTLC timeout tx               B's timeout tx
2965
2966         let chanmon_cfgs = create_chanmon_cfgs(3);
2967         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2968         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2969         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2970
2971         // Create some intial channels
2972         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2973         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2974
2975         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2976         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2977         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2978
2979         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2980         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2981
2982         // Broadcast legit commitment tx from C on B's chain
2983         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2984         check_spends!(commitment_tx[0], chan_2.3);
2985         nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2986         check_added_monitors!(nodes[2], 0);
2987         expect_pending_htlcs_forwardable!(nodes[2]);
2988         check_added_monitors!(nodes[2], 1);
2989
2990         let events = nodes[2].node.get_and_clear_pending_msg_events();
2991         assert_eq!(events.len(), 1);
2992         match events[0] {
2993                 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, .. } } => {
2994                         assert!(update_add_htlcs.is_empty());
2995                         assert!(!update_fail_htlcs.is_empty());
2996                         assert!(update_fulfill_htlcs.is_empty());
2997                         assert!(update_fail_malformed_htlcs.is_empty());
2998                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2999                 },
3000                 _ => panic!("Unexpected event"),
3001         };
3002         connect_block(&nodes[2], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
3003         check_closed_broadcast!(nodes[2], false);
3004         check_added_monitors!(nodes[2], 1);
3005         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
3006         assert_eq!(node_txn.len(), 1);
3007         check_spends!(node_txn[0], chan_2.3);
3008         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
3009
3010         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
3011         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
3012         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
3013         let timeout_tx;
3014         {
3015                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3016                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
3017                 assert_eq!(node_txn[1], node_txn[3]);
3018                 assert_eq!(node_txn[2], node_txn[4]);
3019
3020                 check_spends!(node_txn[0], commitment_tx[0]);
3021                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3022
3023                 check_spends!(node_txn[1], chan_2.3);
3024                 check_spends!(node_txn[2], node_txn[1]);
3025                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
3026                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3027
3028                 timeout_tx = node_txn[0].clone();
3029                 node_txn.clear();
3030         }
3031
3032         connect_block(&nodes[1], &Block { header, txdata: vec![timeout_tx]}, 1);
3033         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
3034         check_added_monitors!(nodes[1], 1);
3035         check_closed_broadcast!(nodes[1], false);
3036
3037         expect_pending_htlcs_forwardable!(nodes[1]);
3038         check_added_monitors!(nodes[1], 1);
3039         let events = nodes[1].node.get_and_clear_pending_msg_events();
3040         assert_eq!(events.len(), 1);
3041         match events[0] {
3042                 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, .. } } => {
3043                         assert!(update_add_htlcs.is_empty());
3044                         assert!(!update_fail_htlcs.is_empty());
3045                         assert!(update_fulfill_htlcs.is_empty());
3046                         assert!(update_fail_malformed_htlcs.is_empty());
3047                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3048                 },
3049                 _ => panic!("Unexpected event"),
3050         };
3051         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // Well... here we detect our own htlc_timeout_tx so no tx to be generated
3052         assert_eq!(node_txn.len(), 0);
3053
3054         // Broadcast legit commitment tx from B on A's chain
3055         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3056         check_spends!(commitment_tx[0], chan_1.3);
3057
3058         connect_block(&nodes[0], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
3059         check_closed_broadcast!(nodes[0], false);
3060         check_added_monitors!(nodes[0], 1);
3061         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
3062         assert_eq!(node_txn.len(), 3);
3063         check_spends!(node_txn[0], commitment_tx[0]);
3064         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3065         check_spends!(node_txn[1], chan_1.3);
3066         check_spends!(node_txn[2], node_txn[1]);
3067         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
3068         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3069 }
3070
3071 #[test]
3072 fn test_simple_commitment_revoked_fail_backward() {
3073         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3074         // and fail backward accordingly.
3075
3076         let chanmon_cfgs = create_chanmon_cfgs(3);
3077         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3078         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3079         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3080
3081         // Create some initial channels
3082         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3083         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3084
3085         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3086         // Get the will-be-revoked local txn from nodes[2]
3087         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3088         // Revoke the old state
3089         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
3090
3091         let (_, payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3092
3093         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3094         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3095         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
3096         check_added_monitors!(nodes[1], 1);
3097         check_closed_broadcast!(nodes[1], false);
3098
3099         expect_pending_htlcs_forwardable!(nodes[1]);
3100         check_added_monitors!(nodes[1], 1);
3101         let events = nodes[1].node.get_and_clear_pending_msg_events();
3102         assert_eq!(events.len(), 1);
3103         match events[0] {
3104                 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, .. } } => {
3105                         assert!(update_add_htlcs.is_empty());
3106                         assert_eq!(update_fail_htlcs.len(), 1);
3107                         assert!(update_fulfill_htlcs.is_empty());
3108                         assert!(update_fail_malformed_htlcs.is_empty());
3109                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3110
3111                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3112                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3113
3114                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3115                         assert_eq!(events.len(), 1);
3116                         match events[0] {
3117                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3118                                 _ => panic!("Unexpected event"),
3119                         }
3120                         expect_payment_failed!(nodes[0], payment_hash, false);
3121                 },
3122                 _ => panic!("Unexpected event"),
3123         }
3124 }
3125
3126 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3127         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3128         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3129         // commitment transaction anymore.
3130         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3131         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3132         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3133         // technically disallowed and we should probably handle it reasonably.
3134         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3135         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3136         // transactions:
3137         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3138         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3139         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3140         //   and once they revoke the previous commitment transaction (allowing us to send a new
3141         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3142         let chanmon_cfgs = create_chanmon_cfgs(3);
3143         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3144         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3145         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3146
3147         // Create some initial channels
3148         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3149         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3150
3151         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
3152         // Get the will-be-revoked local txn from nodes[2]
3153         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3154         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3155         // Revoke the old state
3156         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
3157
3158         let value = if use_dust {
3159                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3160                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3161                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3162         } else { 3000000 };
3163
3164         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3165         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3166         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3167
3168         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, &None));
3169         expect_pending_htlcs_forwardable!(nodes[2]);
3170         check_added_monitors!(nodes[2], 1);
3171         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3172         assert!(updates.update_add_htlcs.is_empty());
3173         assert!(updates.update_fulfill_htlcs.is_empty());
3174         assert!(updates.update_fail_malformed_htlcs.is_empty());
3175         assert_eq!(updates.update_fail_htlcs.len(), 1);
3176         assert!(updates.update_fee.is_none());
3177         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3178         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3179         // Drop the last RAA from 3 -> 2
3180
3181         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, &None));
3182         expect_pending_htlcs_forwardable!(nodes[2]);
3183         check_added_monitors!(nodes[2], 1);
3184         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3185         assert!(updates.update_add_htlcs.is_empty());
3186         assert!(updates.update_fulfill_htlcs.is_empty());
3187         assert!(updates.update_fail_malformed_htlcs.is_empty());
3188         assert_eq!(updates.update_fail_htlcs.len(), 1);
3189         assert!(updates.update_fee.is_none());
3190         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3191         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3192         check_added_monitors!(nodes[1], 1);
3193         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3194         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3195         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3196         check_added_monitors!(nodes[2], 1);
3197
3198         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
3199         expect_pending_htlcs_forwardable!(nodes[2]);
3200         check_added_monitors!(nodes[2], 1);
3201         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3202         assert!(updates.update_add_htlcs.is_empty());
3203         assert!(updates.update_fulfill_htlcs.is_empty());
3204         assert!(updates.update_fail_malformed_htlcs.is_empty());
3205         assert_eq!(updates.update_fail_htlcs.len(), 1);
3206         assert!(updates.update_fee.is_none());
3207         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3208         // At this point first_payment_hash has dropped out of the latest two commitment
3209         // transactions that nodes[1] is tracking...
3210         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3211         check_added_monitors!(nodes[1], 1);
3212         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3213         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3214         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3215         check_added_monitors!(nodes[2], 1);
3216
3217         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3218         // on nodes[2]'s RAA.
3219         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3220         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3221         let logger = test_utils::TestLogger::new();
3222         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(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3223         nodes[1].node.send_payment(&route, fourth_payment_hash, &None).unwrap();
3224         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3225         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3226         check_added_monitors!(nodes[1], 0);
3227
3228         if deliver_bs_raa {
3229                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3230                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3231                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3232                 check_added_monitors!(nodes[1], 1);
3233                 let events = nodes[1].node.get_and_clear_pending_events();
3234                 assert_eq!(events.len(), 1);
3235                 match events[0] {
3236                         Event::PendingHTLCsForwardable { .. } => { },
3237                         _ => panic!("Unexpected event"),
3238                 };
3239                 // Deliberately don't process the pending fail-back so they all fail back at once after
3240                 // block connection just like the !deliver_bs_raa case
3241         }
3242
3243         let mut failed_htlcs = HashSet::new();
3244         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3245
3246         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3247         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3248         check_added_monitors!(nodes[1], 1);
3249         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
3250
3251         let events = nodes[1].node.get_and_clear_pending_events();
3252         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3253         match events[0] {
3254                 Event::PaymentFailed { ref payment_hash, .. } => {
3255                         assert_eq!(*payment_hash, fourth_payment_hash);
3256                 },
3257                 _ => panic!("Unexpected event"),
3258         }
3259         if !deliver_bs_raa {
3260                 match events[1] {
3261                         Event::PendingHTLCsForwardable { .. } => { },
3262                         _ => panic!("Unexpected event"),
3263                 };
3264         }
3265         nodes[1].node.process_pending_htlc_forwards();
3266         check_added_monitors!(nodes[1], 1);
3267
3268         let events = nodes[1].node.get_and_clear_pending_msg_events();
3269         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
3270         match events[if deliver_bs_raa { 1 } else { 0 }] {
3271                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3272                 _ => panic!("Unexpected event"),
3273         }
3274         if deliver_bs_raa {
3275                 match events[0] {
3276                         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, .. } } => {
3277                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3278                                 assert_eq!(update_add_htlcs.len(), 1);
3279                                 assert!(update_fulfill_htlcs.is_empty());
3280                                 assert!(update_fail_htlcs.is_empty());
3281                                 assert!(update_fail_malformed_htlcs.is_empty());
3282                         },
3283                         _ => panic!("Unexpected event"),
3284                 }
3285         }
3286         match events[if deliver_bs_raa { 2 } else { 1 }] {
3287                 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, .. } } => {
3288                         assert!(update_add_htlcs.is_empty());
3289                         assert_eq!(update_fail_htlcs.len(), 3);
3290                         assert!(update_fulfill_htlcs.is_empty());
3291                         assert!(update_fail_malformed_htlcs.is_empty());
3292                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3293
3294                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3295                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3296                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3297
3298                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3299
3300                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3301                         // If we delivered B's RAA we got an unknown preimage error, not something
3302                         // that we should update our routing table for.
3303                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3304                         for event in events {
3305                                 match event {
3306                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3307                                         _ => panic!("Unexpected event"),
3308                                 }
3309                         }
3310                         let events = nodes[0].node.get_and_clear_pending_events();
3311                         assert_eq!(events.len(), 3);
3312                         match events[0] {
3313                                 Event::PaymentFailed { ref payment_hash, .. } => {
3314                                         assert!(failed_htlcs.insert(payment_hash.0));
3315                                 },
3316                                 _ => panic!("Unexpected event"),
3317                         }
3318                         match events[1] {
3319                                 Event::PaymentFailed { ref payment_hash, .. } => {
3320                                         assert!(failed_htlcs.insert(payment_hash.0));
3321                                 },
3322                                 _ => panic!("Unexpected event"),
3323                         }
3324                         match events[2] {
3325                                 Event::PaymentFailed { ref payment_hash, .. } => {
3326                                         assert!(failed_htlcs.insert(payment_hash.0));
3327                                 },
3328                                 _ => panic!("Unexpected event"),
3329                         }
3330                 },
3331                 _ => panic!("Unexpected event"),
3332         }
3333
3334         assert!(failed_htlcs.contains(&first_payment_hash.0));
3335         assert!(failed_htlcs.contains(&second_payment_hash.0));
3336         assert!(failed_htlcs.contains(&third_payment_hash.0));
3337 }
3338
3339 #[test]
3340 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3341         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3342         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3343         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3344         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3345 }
3346
3347 #[test]
3348 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3349         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3350         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3351         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3352         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3353 }
3354
3355 #[test]
3356 fn fail_backward_pending_htlc_upon_channel_failure() {
3357         let chanmon_cfgs = create_chanmon_cfgs(2);
3358         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3359         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3360         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3361         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3362         let logger = test_utils::TestLogger::new();
3363
3364         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3365         {
3366                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
3367                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3368                 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(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3369                 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
3370                 check_added_monitors!(nodes[0], 1);
3371
3372                 let payment_event = {
3373                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3374                         assert_eq!(events.len(), 1);
3375                         SendEvent::from_event(events.remove(0))
3376                 };
3377                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3378                 assert_eq!(payment_event.msgs.len(), 1);
3379         }
3380
3381         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3382         let (_, failed_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3383         {
3384                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3385                 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(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3386                 nodes[0].node.send_payment(&route, failed_payment_hash, &None).unwrap();
3387                 check_added_monitors!(nodes[0], 0);
3388
3389                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3390         }
3391
3392         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3393         {
3394                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[1]);
3395
3396                 let secp_ctx = Secp256k1::new();
3397                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3398                 let current_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
3399                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3400                 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(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3401                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &None, current_height).unwrap();
3402                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3403                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3404
3405                 // Send a 0-msat update_add_htlc to fail the channel.
3406                 let update_add_htlc = msgs::UpdateAddHTLC {
3407                         channel_id: chan.2,
3408                         htlc_id: 0,
3409                         amount_msat: 0,
3410                         payment_hash,
3411                         cltv_expiry,
3412                         onion_routing_packet,
3413                 };
3414                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3415         }
3416
3417         // Check that Alice fails backward the pending HTLC from the second payment.
3418         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3419         check_closed_broadcast!(nodes[0], true);
3420         check_added_monitors!(nodes[0], 1);
3421 }
3422
3423 #[test]
3424 fn test_htlc_ignore_latest_remote_commitment() {
3425         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3426         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3427         let chanmon_cfgs = create_chanmon_cfgs(2);
3428         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3429         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3430         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3431         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3432
3433         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3434         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3435         check_closed_broadcast!(nodes[0], false);
3436         check_added_monitors!(nodes[0], 1);
3437
3438         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3439         assert_eq!(node_txn.len(), 2);
3440
3441         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3442         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3443         check_closed_broadcast!(nodes[1], false);
3444         check_added_monitors!(nodes[1], 1);
3445
3446         // Duplicate the connect_block call since this may happen due to other listeners
3447         // registering new transactions
3448         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3449 }
3450
3451 #[test]
3452 fn test_force_close_fail_back() {
3453         // Check which HTLCs are failed-backwards on channel force-closure
3454         let chanmon_cfgs = create_chanmon_cfgs(3);
3455         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3456         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3457         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3458         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3459         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3460         let logger = test_utils::TestLogger::new();
3461
3462         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3463
3464         let mut payment_event = {
3465                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3466                 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(), None, &Vec::new(), 1000000, 42, &logger).unwrap();
3467                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
3468                 check_added_monitors!(nodes[0], 1);
3469
3470                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3471                 assert_eq!(events.len(), 1);
3472                 SendEvent::from_event(events.remove(0))
3473         };
3474
3475         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3476         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3477
3478         expect_pending_htlcs_forwardable!(nodes[1]);
3479
3480         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3481         assert_eq!(events_2.len(), 1);
3482         payment_event = SendEvent::from_event(events_2.remove(0));
3483         assert_eq!(payment_event.msgs.len(), 1);
3484
3485         check_added_monitors!(nodes[1], 1);
3486         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3487         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3488         check_added_monitors!(nodes[2], 1);
3489         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3490
3491         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3492         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3493         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3494
3495         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3496         check_closed_broadcast!(nodes[2], false);
3497         check_added_monitors!(nodes[2], 1);
3498         let tx = {
3499                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3500                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3501                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3502                 // back to nodes[1] upon timeout otherwise.
3503                 assert_eq!(node_txn.len(), 1);
3504                 node_txn.remove(0)
3505         };
3506
3507         let block = Block {
3508                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
3509                 txdata: vec![tx.clone()],
3510         };
3511         connect_block(&nodes[1], &block, 1);
3512
3513         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3514         check_closed_broadcast!(nodes[1], false);
3515         check_added_monitors!(nodes[1], 1);
3516
3517         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3518         {
3519                 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.lock().unwrap();
3520                 monitors.get_mut(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3521                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3522         }
3523         connect_block(&nodes[2], &block, 1);
3524         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3525         assert_eq!(node_txn.len(), 1);
3526         assert_eq!(node_txn[0].input.len(), 1);
3527         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3528         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3529         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3530
3531         check_spends!(node_txn[0], tx);
3532 }
3533
3534 #[test]
3535 fn test_unconf_chan() {
3536         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3537         let chanmon_cfgs = create_chanmon_cfgs(2);
3538         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3539         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3540         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3541         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3542
3543         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3544         assert_eq!(channel_state.by_id.len(), 1);
3545         assert_eq!(channel_state.short_to_id.len(), 1);
3546         mem::drop(channel_state);
3547
3548         let mut headers = Vec::new();
3549         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3550         headers.push(header.clone());
3551         for _i in 2..100 {
3552                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3553                 headers.push(header.clone());
3554         }
3555         while !headers.is_empty() {
3556                 nodes[0].node.block_disconnected(&headers.pop().unwrap());
3557         }
3558         check_closed_broadcast!(nodes[0], false);
3559         check_added_monitors!(nodes[0], 1);
3560         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3561         assert_eq!(channel_state.by_id.len(), 0);
3562         assert_eq!(channel_state.short_to_id.len(), 0);
3563 }
3564
3565 #[test]
3566 fn test_simple_peer_disconnect() {
3567         // Test that we can reconnect when there are no lost messages
3568         let chanmon_cfgs = create_chanmon_cfgs(3);
3569         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3570         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3571         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3572         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3573         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3574
3575         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3576         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3577         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3578
3579         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3580         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3581         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3582         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3583
3584         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3585         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3586         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3587
3588         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3589         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3590         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3591         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3592
3593         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3594         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3595
3596         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3597         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3598
3599         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3600         {
3601                 let events = nodes[0].node.get_and_clear_pending_events();
3602                 assert_eq!(events.len(), 2);
3603                 match events[0] {
3604                         Event::PaymentSent { payment_preimage } => {
3605                                 assert_eq!(payment_preimage, payment_preimage_3);
3606                         },
3607                         _ => panic!("Unexpected event"),
3608                 }
3609                 match events[1] {
3610                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3611                                 assert_eq!(payment_hash, payment_hash_5);
3612                                 assert!(rejected_by_dest);
3613                         },
3614                         _ => panic!("Unexpected event"),
3615                 }
3616         }
3617
3618         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3619         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3620 }
3621
3622 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3623         // Test that we can reconnect when in-flight HTLC updates get dropped
3624         let chanmon_cfgs = create_chanmon_cfgs(2);
3625         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3626         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3627         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3628         if messages_delivered == 0 {
3629                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3630                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3631         } else {
3632                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3633         }
3634
3635         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3636
3637         let logger = test_utils::TestLogger::new();
3638         let payment_event = {
3639                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3640                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3641                         &nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3642                         &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3643                 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
3644                 check_added_monitors!(nodes[0], 1);
3645
3646                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3647                 assert_eq!(events.len(), 1);
3648                 SendEvent::from_event(events.remove(0))
3649         };
3650         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3651
3652         if messages_delivered < 2 {
3653                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3654         } else {
3655                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3656                 if messages_delivered >= 3 {
3657                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3658                         check_added_monitors!(nodes[1], 1);
3659                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3660
3661                         if messages_delivered >= 4 {
3662                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3663                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3664                                 check_added_monitors!(nodes[0], 1);
3665
3666                                 if messages_delivered >= 5 {
3667                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3668                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3669                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3670                                         check_added_monitors!(nodes[0], 1);
3671
3672                                         if messages_delivered >= 6 {
3673                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3674                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3675                                                 check_added_monitors!(nodes[1], 1);
3676                                         }
3677                                 }
3678                         }
3679                 }
3680         }
3681
3682         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3683         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3684         if messages_delivered < 3 {
3685                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3686                 // received on either side, both sides will need to resend them.
3687                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3688         } else if messages_delivered == 3 {
3689                 // nodes[0] still wants its RAA + commitment_signed
3690                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3691         } else if messages_delivered == 4 {
3692                 // nodes[0] still wants its commitment_signed
3693                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3694         } else if messages_delivered == 5 {
3695                 // nodes[1] still wants its final RAA
3696                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3697         } else if messages_delivered == 6 {
3698                 // Everything was delivered...
3699                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3700         }
3701
3702         let events_1 = nodes[1].node.get_and_clear_pending_events();
3703         assert_eq!(events_1.len(), 1);
3704         match events_1[0] {
3705                 Event::PendingHTLCsForwardable { .. } => { },
3706                 _ => panic!("Unexpected event"),
3707         };
3708
3709         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3710         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3711         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3712
3713         nodes[1].node.process_pending_htlc_forwards();
3714
3715         let events_2 = nodes[1].node.get_and_clear_pending_events();
3716         assert_eq!(events_2.len(), 1);
3717         match events_2[0] {
3718                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
3719                         assert_eq!(payment_hash_1, *payment_hash);
3720                         assert_eq!(*payment_secret, None);
3721                         assert_eq!(amt, 1000000);
3722                 },
3723                 _ => panic!("Unexpected event"),
3724         }
3725
3726         nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3727         check_added_monitors!(nodes[1], 1);
3728
3729         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3730         assert_eq!(events_3.len(), 1);
3731         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3732                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3733                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3734                         assert!(updates.update_add_htlcs.is_empty());
3735                         assert!(updates.update_fail_htlcs.is_empty());
3736                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3737                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3738                         assert!(updates.update_fee.is_none());
3739                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3740                 },
3741                 _ => panic!("Unexpected event"),
3742         };
3743
3744         if messages_delivered >= 1 {
3745                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3746
3747                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3748                 assert_eq!(events_4.len(), 1);
3749                 match events_4[0] {
3750                         Event::PaymentSent { ref payment_preimage } => {
3751                                 assert_eq!(payment_preimage_1, *payment_preimage);
3752                         },
3753                         _ => panic!("Unexpected event"),
3754                 }
3755
3756                 if messages_delivered >= 2 {
3757                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3758                         check_added_monitors!(nodes[0], 1);
3759                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3760
3761                         if messages_delivered >= 3 {
3762                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3763                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3764                                 check_added_monitors!(nodes[1], 1);
3765
3766                                 if messages_delivered >= 4 {
3767                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3768                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3769                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3770                                         check_added_monitors!(nodes[1], 1);
3771
3772                                         if messages_delivered >= 5 {
3773                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3774                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3775                                                 check_added_monitors!(nodes[0], 1);
3776                                         }
3777                                 }
3778                         }
3779                 }
3780         }
3781
3782         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3783         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3784         if messages_delivered < 2 {
3785                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3786                 //TODO: Deduplicate PaymentSent events, then enable this if:
3787                 //if messages_delivered < 1 {
3788                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3789                         assert_eq!(events_4.len(), 1);
3790                         match events_4[0] {
3791                                 Event::PaymentSent { ref payment_preimage } => {
3792                                         assert_eq!(payment_preimage_1, *payment_preimage);
3793                                 },
3794                                 _ => panic!("Unexpected event"),
3795                         }
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(&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, 1_000_000);
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 nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3846         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3847
3848         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3849         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3850
3851         confirm_transaction(&nodes[0], &tx);
3852         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3853         assert_eq!(events_1.len(), 1);
3854         match events_1[0] {
3855                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3856                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3857                 },
3858                 _ => panic!("Unexpected event"),
3859         }
3860
3861         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3862
3863         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3864         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3865
3866         confirm_transaction(&nodes[1], &tx);
3867         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3868         assert_eq!(events_2.len(), 2);
3869         let funding_locked = match events_2[0] {
3870                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3871                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3872                         msg.clone()
3873                 },
3874                 _ => panic!("Unexpected event"),
3875         };
3876         let bs_announcement_sigs = match events_2[1] {
3877                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3878                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3879                         msg.clone()
3880                 },
3881                 _ => panic!("Unexpected event"),
3882         };
3883
3884         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3885
3886         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3887         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3888         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3889         assert_eq!(events_3.len(), 2);
3890         let as_announcement_sigs = match events_3[0] {
3891                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3892                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3893                         msg.clone()
3894                 },
3895                 _ => panic!("Unexpected event"),
3896         };
3897         let (as_announcement, as_update) = match events_3[1] {
3898                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3899                         (msg.clone(), update_msg.clone())
3900                 },
3901                 _ => panic!("Unexpected event"),
3902         };
3903
3904         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3905         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3906         assert_eq!(events_4.len(), 1);
3907         let (_, bs_update) = match events_4[0] {
3908                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3909                         (msg.clone(), update_msg.clone())
3910                 },
3911                 _ => panic!("Unexpected event"),
3912         };
3913
3914         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3915         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3916         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3917
3918         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3919         let logger = test_utils::TestLogger::new();
3920         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3921         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3922         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3923 }
3924
3925 #[test]
3926 fn test_drop_messages_peer_disconnect_dual_htlc() {
3927         // Test that we can handle reconnecting when both sides of a channel have pending
3928         // commitment_updates when we disconnect.
3929         let chanmon_cfgs = create_chanmon_cfgs(2);
3930         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3931         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3932         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3933         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3934         let logger = test_utils::TestLogger::new();
3935
3936         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3937
3938         // Now try to send a second payment which will fail to send
3939         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3940         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3941         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(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3942         nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
3943         check_added_monitors!(nodes[0], 1);
3944
3945         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3946         assert_eq!(events_1.len(), 1);
3947         match events_1[0] {
3948                 MessageSendEvent::UpdateHTLCs { .. } => {},
3949                 _ => panic!("Unexpected event"),
3950         }
3951
3952         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3953         check_added_monitors!(nodes[1], 1);
3954
3955         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3956         assert_eq!(events_2.len(), 1);
3957         match events_2[0] {
3958                 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 } } => {
3959                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3960                         assert!(update_add_htlcs.is_empty());
3961                         assert_eq!(update_fulfill_htlcs.len(), 1);
3962                         assert!(update_fail_htlcs.is_empty());
3963                         assert!(update_fail_malformed_htlcs.is_empty());
3964                         assert!(update_fee.is_none());
3965
3966                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3967                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3968                         assert_eq!(events_3.len(), 1);
3969                         match events_3[0] {
3970                                 Event::PaymentSent { ref payment_preimage } => {
3971                                         assert_eq!(*payment_preimage, payment_preimage_1);
3972                                 },
3973                                 _ => panic!("Unexpected event"),
3974                         }
3975
3976                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3977                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3978                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3979                         check_added_monitors!(nodes[0], 1);
3980                 },
3981                 _ => panic!("Unexpected event"),
3982         }
3983
3984         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3985         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3986
3987         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3988         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3989         assert_eq!(reestablish_1.len(), 1);
3990         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3991         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3992         assert_eq!(reestablish_2.len(), 1);
3993
3994         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3995         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3996         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3997         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3998
3999         assert!(as_resp.0.is_none());
4000         assert!(bs_resp.0.is_none());
4001
4002         assert!(bs_resp.1.is_none());
4003         assert!(bs_resp.2.is_none());
4004
4005         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4006
4007         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
4008         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
4009         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4010         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4011         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
4012         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
4013         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
4014         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4015         // No commitment_signed so get_event_msg's assert(len == 1) passes
4016         check_added_monitors!(nodes[1], 1);
4017
4018         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
4019         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4020         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4021         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4022         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4023         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4024         assert!(bs_second_commitment_signed.update_fee.is_none());
4025         check_added_monitors!(nodes[1], 1);
4026
4027         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4028         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4029         assert!(as_commitment_signed.update_add_htlcs.is_empty());
4030         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4031         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4032         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4033         assert!(as_commitment_signed.update_fee.is_none());
4034         check_added_monitors!(nodes[0], 1);
4035
4036         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4037         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4038         // No commitment_signed so get_event_msg's assert(len == 1) passes
4039         check_added_monitors!(nodes[0], 1);
4040
4041         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4042         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4043         // No commitment_signed so get_event_msg's assert(len == 1) passes
4044         check_added_monitors!(nodes[1], 1);
4045
4046         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4047         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4048         check_added_monitors!(nodes[1], 1);
4049
4050         expect_pending_htlcs_forwardable!(nodes[1]);
4051
4052         let events_5 = nodes[1].node.get_and_clear_pending_events();
4053         assert_eq!(events_5.len(), 1);
4054         match events_5[0] {
4055                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _ } => {
4056                         assert_eq!(payment_hash_2, *payment_hash);
4057                         assert_eq!(*payment_secret, None);
4058                 },
4059                 _ => panic!("Unexpected event"),
4060         }
4061
4062         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4063         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4064         check_added_monitors!(nodes[0], 1);
4065
4066         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
4067 }
4068
4069 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4070         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4071         // to avoid our counterparty failing the channel.
4072         let chanmon_cfgs = create_chanmon_cfgs(2);
4073         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4074         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4075         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4076
4077         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4078         let logger = test_utils::TestLogger::new();
4079
4080         let our_payment_hash = if send_partial_mpp {
4081                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4082                 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(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4083                 let (_, our_payment_hash) = get_payment_preimage_hash!(&nodes[0]);
4084                 let payment_secret = PaymentSecret([0xdb; 32]);
4085                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4086                 // indicates there are more HTLCs coming.
4087                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, CHAN_CONFIRM_DEPTH).unwrap();
4088                 check_added_monitors!(nodes[0], 1);
4089                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4090                 assert_eq!(events.len(), 1);
4091                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4092                 // hop should *not* yet generate any PaymentReceived event(s).
4093                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false);
4094                 our_payment_hash
4095         } else {
4096                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4097         };
4098
4099         let mut block = Block {
4100                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4101                 txdata: vec![],
4102         };
4103         connect_block(&nodes[0], &block, 101);
4104         connect_block(&nodes[1], &block, 101);
4105         for i in 102..TEST_FINAL_CLTV + 100 + 1 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4106                 block.header.prev_blockhash = block.block_hash();
4107                 connect_block(&nodes[0], &block, i);
4108                 connect_block(&nodes[1], &block, i);
4109         }
4110
4111         expect_pending_htlcs_forwardable!(nodes[1]);
4112
4113         check_added_monitors!(nodes[1], 1);
4114         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4115         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4116         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4117         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4118         assert!(htlc_timeout_updates.update_fee.is_none());
4119
4120         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4121         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4122         // 100_000 msat as u64, followed by a height of 123 as u32
4123         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4124         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(123));
4125         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4126 }
4127
4128 #[test]
4129 fn test_htlc_timeout() {
4130         do_test_htlc_timeout(true);
4131         do_test_htlc_timeout(false);
4132 }
4133
4134 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4135         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4136         let chanmon_cfgs = create_chanmon_cfgs(3);
4137         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4138         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4139         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4140         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4141         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4142         let logger = test_utils::TestLogger::new();
4143
4144         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4145         let (_, first_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4146         {
4147                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4148                 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(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4149                 nodes[1].node.send_payment(&route, first_payment_hash, &None).unwrap();
4150         }
4151         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4152         check_added_monitors!(nodes[1], 1);
4153
4154         // Now attempt to route a second payment, which should be placed in the holding cell
4155         let (_, second_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4156         if forwarded_htlc {
4157                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4158                 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(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4159                 nodes[0].node.send_payment(&route, second_payment_hash, &None).unwrap();
4160                 check_added_monitors!(nodes[0], 1);
4161                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4162                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4163                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4164                 expect_pending_htlcs_forwardable!(nodes[1]);
4165                 check_added_monitors!(nodes[1], 0);
4166         } else {
4167                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4168                 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(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4169                 nodes[1].node.send_payment(&route, second_payment_hash, &None).unwrap();
4170                 check_added_monitors!(nodes[1], 0);
4171         }
4172
4173         let mut block = Block {
4174                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4175                 txdata: vec![],
4176         };
4177         connect_block(&nodes[1], &block, 101);
4178         for i in 102..TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4179                 block.header.prev_blockhash = block.block_hash();
4180                 connect_block(&nodes[1], &block, i);
4181         }
4182
4183         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4184         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4185
4186         block.header.prev_blockhash = block.block_hash();
4187         connect_block(&nodes[1], &block, TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4188
4189         if forwarded_htlc {
4190                 expect_pending_htlcs_forwardable!(nodes[1]);
4191                 check_added_monitors!(nodes[1], 1);
4192                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4193                 assert_eq!(fail_commit.len(), 1);
4194                 match fail_commit[0] {
4195                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4196                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4197                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4198                         },
4199                         _ => unreachable!(),
4200                 }
4201                 expect_payment_failed!(nodes[0], second_payment_hash, false);
4202                 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4203                         match update {
4204                                 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4205                                 _ => panic!("Unexpected event"),
4206                         }
4207                 } else {
4208                         panic!("Unexpected event");
4209                 }
4210         } else {
4211                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4212         }
4213 }
4214
4215 #[test]
4216 fn test_holding_cell_htlc_add_timeouts() {
4217         do_test_holding_cell_htlc_add_timeouts(false);
4218         do_test_holding_cell_htlc_add_timeouts(true);
4219 }
4220
4221 #[test]
4222 fn test_invalid_channel_announcement() {
4223         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4224         let secp_ctx = Secp256k1::new();
4225         let chanmon_cfgs = create_chanmon_cfgs(2);
4226         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4227         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4228         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4229
4230         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4231
4232         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4233         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4234         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4235         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4236
4237         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 } );
4238
4239         let as_bitcoin_key = as_chan.get_keys().inner.holder_channel_pubkeys.funding_pubkey;
4240         let bs_bitcoin_key = bs_chan.get_keys().inner.holder_channel_pubkeys.funding_pubkey;
4241
4242         let as_network_key = nodes[0].node.get_our_node_id();
4243         let bs_network_key = nodes[1].node.get_our_node_id();
4244
4245         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4246
4247         let mut chan_announcement;
4248
4249         macro_rules! dummy_unsigned_msg {
4250                 () => {
4251                         msgs::UnsignedChannelAnnouncement {
4252                                 features: ChannelFeatures::known(),
4253                                 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4254                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4255                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4256                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4257                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4258                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4259                                 excess_data: Vec::new(),
4260                         };
4261                 }
4262         }
4263
4264         macro_rules! sign_msg {
4265                 ($unsigned_msg: expr) => {
4266                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4267                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_keys().inner.funding_key);
4268                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_keys().inner.funding_key);
4269                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4270                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4271                         chan_announcement = msgs::ChannelAnnouncement {
4272                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4273                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4274                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4275                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4276                                 contents: $unsigned_msg
4277                         }
4278                 }
4279         }
4280
4281         let unsigned_msg = dummy_unsigned_msg!();
4282         sign_msg!(unsigned_msg);
4283         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4284         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 } );
4285
4286         // Configured with Network::Testnet
4287         let mut unsigned_msg = dummy_unsigned_msg!();
4288         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4289         sign_msg!(unsigned_msg);
4290         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4291
4292         let mut unsigned_msg = dummy_unsigned_msg!();
4293         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4294         sign_msg!(unsigned_msg);
4295         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4296 }
4297
4298 #[test]
4299 fn test_no_txn_manager_serialize_deserialize() {
4300         let chanmon_cfgs = create_chanmon_cfgs(2);
4301         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4302         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4303         let logger: test_utils::TestLogger;
4304         let fee_estimator: test_utils::TestFeeEstimator;
4305         let persister: test_utils::TestPersister;
4306         let new_chain_monitor: test_utils::TestChainMonitor;
4307         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4308         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4309
4310         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4311
4312         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4313
4314         let nodes_0_serialized = nodes[0].node.encode();
4315         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4316         nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4317
4318         logger = test_utils::TestLogger::new();
4319         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4320         persister = test_utils::TestPersister::new();
4321         let keys_manager = &chanmon_cfgs[0].keys_manager;
4322         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4323         nodes[0].chain_monitor = &new_chain_monitor;
4324         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4325         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(
4326                 &mut chan_0_monitor_read, keys_manager).unwrap();
4327         assert!(chan_0_monitor_read.is_empty());
4328
4329         let mut nodes_0_read = &nodes_0_serialized[..];
4330         let config = UserConfig::default();
4331         let (_, nodes_0_deserialized_tmp) = {
4332                 let mut channel_monitors = HashMap::new();
4333                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4334                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4335                         default_config: config,
4336                         keys_manager,
4337                         fee_estimator: &fee_estimator,
4338                         chain_monitor: nodes[0].chain_monitor,
4339                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4340                         logger: &logger,
4341                         channel_monitors,
4342                 }).unwrap()
4343         };
4344         nodes_0_deserialized = nodes_0_deserialized_tmp;
4345         assert!(nodes_0_read.is_empty());
4346
4347         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4348         nodes[0].node = &nodes_0_deserialized;
4349         assert_eq!(nodes[0].node.list_channels().len(), 1);
4350         check_added_monitors!(nodes[0], 1);
4351
4352         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4353         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4354         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4355         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4356
4357         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4358         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4359         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4360         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4361
4362         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4363         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4364         for node in nodes.iter() {
4365                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4366                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4367                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4368         }
4369
4370         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4371 }
4372
4373 #[test]
4374 fn test_manager_serialize_deserialize_events() {
4375         // This test makes sure the events field in ChannelManager survives de/serialization
4376         let chanmon_cfgs = create_chanmon_cfgs(2);
4377         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4378         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4379         let fee_estimator: test_utils::TestFeeEstimator;
4380         let persister: test_utils::TestPersister;
4381         let logger: test_utils::TestLogger;
4382         let new_chain_monitor: test_utils::TestChainMonitor;
4383         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4384         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4385
4386         // Start creating a channel, but stop right before broadcasting the event message FundingBroadcastSafe
4387         let channel_value = 100000;
4388         let push_msat = 10001;
4389         let a_flags = InitFeatures::known();
4390         let b_flags = InitFeatures::known();
4391         let node_a = nodes.remove(0);
4392         let node_b = nodes.remove(0);
4393         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4394         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()));
4395         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()));
4396
4397         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4398
4399         node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
4400         check_added_monitors!(node_a, 0);
4401
4402         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()));
4403         {
4404                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4405                 assert_eq!(added_monitors.len(), 1);
4406                 assert_eq!(added_monitors[0].0, funding_output);
4407                 added_monitors.clear();
4408         }
4409
4410         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()));
4411         {
4412                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4413                 assert_eq!(added_monitors.len(), 1);
4414                 assert_eq!(added_monitors[0].0, funding_output);
4415                 added_monitors.clear();
4416         }
4417         // Normally, this is where node_a would check for a FundingBroadcastSafe event, but the test de/serializes first instead
4418
4419         nodes.push(node_a);
4420         nodes.push(node_b);
4421
4422         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4423         let nodes_0_serialized = nodes[0].node.encode();
4424         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4425         nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4426
4427         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4428         logger = test_utils::TestLogger::new();
4429         persister = test_utils::TestPersister::new();
4430         let keys_manager = &chanmon_cfgs[0].keys_manager;
4431         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4432         nodes[0].chain_monitor = &new_chain_monitor;
4433         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4434         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(
4435                 &mut chan_0_monitor_read, keys_manager).unwrap();
4436         assert!(chan_0_monitor_read.is_empty());
4437
4438         let mut nodes_0_read = &nodes_0_serialized[..];
4439         let config = UserConfig::default();
4440         let (_, nodes_0_deserialized_tmp) = {
4441                 let mut channel_monitors = HashMap::new();
4442                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4443                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4444                         default_config: config,
4445                         keys_manager,
4446                         fee_estimator: &fee_estimator,
4447                         chain_monitor: nodes[0].chain_monitor,
4448                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4449                         logger: &logger,
4450                         channel_monitors,
4451                 }).unwrap()
4452         };
4453         nodes_0_deserialized = nodes_0_deserialized_tmp;
4454         assert!(nodes_0_read.is_empty());
4455
4456         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4457
4458         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4459         nodes[0].node = &nodes_0_deserialized;
4460
4461         // After deserializing, make sure the FundingBroadcastSafe event is still held by the channel manager
4462         let events_4 = nodes[0].node.get_and_clear_pending_events();
4463         assert_eq!(events_4.len(), 1);
4464         match events_4[0] {
4465                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
4466                         assert_eq!(user_channel_id, 42);
4467                         assert_eq!(*funding_txo, funding_output);
4468                 },
4469                 _ => panic!("Unexpected event"),
4470         };
4471
4472         // Make sure the channel is functioning as though the de/serialization never happened
4473         assert_eq!(nodes[0].node.list_channels().len(), 1);
4474         check_added_monitors!(nodes[0], 1);
4475
4476         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4477         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4478         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4479         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4480
4481         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4482         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4483         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4484         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4485
4486         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4487         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4488         for node in nodes.iter() {
4489                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4490                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4491                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4492         }
4493
4494         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4495 }
4496
4497 #[test]
4498 fn test_simple_manager_serialize_deserialize() {
4499         let chanmon_cfgs = create_chanmon_cfgs(2);
4500         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4501         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4502         let logger: test_utils::TestLogger;
4503         let fee_estimator: test_utils::TestFeeEstimator;
4504         let persister: test_utils::TestPersister;
4505         let new_chain_monitor: test_utils::TestChainMonitor;
4506         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4507         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4508         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4509
4510         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4511         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4512
4513         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4514
4515         let nodes_0_serialized = nodes[0].node.encode();
4516         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4517         nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4518
4519         logger = test_utils::TestLogger::new();
4520         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4521         persister = test_utils::TestPersister::new();
4522         let keys_manager = &chanmon_cfgs[0].keys_manager;
4523         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4524         nodes[0].chain_monitor = &new_chain_monitor;
4525         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4526         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(
4527                 &mut chan_0_monitor_read, keys_manager).unwrap();
4528         assert!(chan_0_monitor_read.is_empty());
4529
4530         let mut nodes_0_read = &nodes_0_serialized[..];
4531         let (_, nodes_0_deserialized_tmp) = {
4532                 let mut channel_monitors = HashMap::new();
4533                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4534                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4535                         default_config: UserConfig::default(),
4536                         keys_manager,
4537                         fee_estimator: &fee_estimator,
4538                         chain_monitor: nodes[0].chain_monitor,
4539                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4540                         logger: &logger,
4541                         channel_monitors,
4542                 }).unwrap()
4543         };
4544         nodes_0_deserialized = nodes_0_deserialized_tmp;
4545         assert!(nodes_0_read.is_empty());
4546
4547         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4548         nodes[0].node = &nodes_0_deserialized;
4549         check_added_monitors!(nodes[0], 1);
4550
4551         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4552
4553         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4554         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
4555 }
4556
4557 #[test]
4558 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4559         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4560         let chanmon_cfgs = create_chanmon_cfgs(4);
4561         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4562         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4563         let logger: test_utils::TestLogger;
4564         let fee_estimator: test_utils::TestFeeEstimator;
4565         let persister: test_utils::TestPersister;
4566         let new_chain_monitor: test_utils::TestChainMonitor;
4567         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4568         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4569         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4570         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4571         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4572
4573         let mut node_0_stale_monitors_serialized = Vec::new();
4574         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter() {
4575                 let mut writer = test_utils::TestVecWriter(Vec::new());
4576                 monitor.1.write(&mut writer).unwrap();
4577                 node_0_stale_monitors_serialized.push(writer.0);
4578         }
4579
4580         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4581
4582         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4583         let nodes_0_serialized = nodes[0].node.encode();
4584
4585         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4586         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4587         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4588         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4589
4590         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4591         // nodes[3])
4592         let mut node_0_monitors_serialized = Vec::new();
4593         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter() {
4594                 let mut writer = test_utils::TestVecWriter(Vec::new());
4595                 monitor.1.write(&mut writer).unwrap();
4596                 node_0_monitors_serialized.push(writer.0);
4597         }
4598
4599         logger = test_utils::TestLogger::new();
4600         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4601         persister = test_utils::TestPersister::new();
4602         let keys_manager = &chanmon_cfgs[0].keys_manager;
4603         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4604         nodes[0].chain_monitor = &new_chain_monitor;
4605
4606
4607         let mut node_0_stale_monitors = Vec::new();
4608         for serialized in node_0_stale_monitors_serialized.iter() {
4609                 let mut read = &serialized[..];
4610                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read, keys_manager).unwrap();
4611                 assert!(read.is_empty());
4612                 node_0_stale_monitors.push(monitor);
4613         }
4614
4615         let mut node_0_monitors = Vec::new();
4616         for serialized in node_0_monitors_serialized.iter() {
4617                 let mut read = &serialized[..];
4618                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read, keys_manager).unwrap();
4619                 assert!(read.is_empty());
4620                 node_0_monitors.push(monitor);
4621         }
4622
4623         let mut nodes_0_read = &nodes_0_serialized[..];
4624         if let Err(msgs::DecodeError::InvalidValue) =
4625                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4626                 default_config: UserConfig::default(),
4627                 keys_manager,
4628                 fee_estimator: &fee_estimator,
4629                 chain_monitor: nodes[0].chain_monitor,
4630                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4631                 logger: &logger,
4632                 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4633         }) { } else {
4634                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4635         };
4636
4637         let mut nodes_0_read = &nodes_0_serialized[..];
4638         let (_, nodes_0_deserialized_tmp) =
4639                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4640                 default_config: UserConfig::default(),
4641                 keys_manager,
4642                 fee_estimator: &fee_estimator,
4643                 chain_monitor: nodes[0].chain_monitor,
4644                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4645                 logger: &logger,
4646                 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4647         }).unwrap();
4648         nodes_0_deserialized = nodes_0_deserialized_tmp;
4649         assert!(nodes_0_read.is_empty());
4650
4651         { // Channel close should result in a commitment tx and an HTLC tx
4652                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4653                 assert_eq!(txn.len(), 2);
4654                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4655                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4656         }
4657
4658         for monitor in node_0_monitors.drain(..) {
4659                 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4660                 check_added_monitors!(nodes[0], 1);
4661         }
4662         nodes[0].node = &nodes_0_deserialized;
4663
4664         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4665         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4666         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4667         //... and we can even still claim the payment!
4668         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
4669
4670         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4671         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4672         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4673         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4674         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4675         assert_eq!(msg_events.len(), 1);
4676         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4677                 match action {
4678                         &ErrorAction::SendErrorMessage { ref msg } => {
4679                                 assert_eq!(msg.channel_id, channel_id);
4680                         },
4681                         _ => panic!("Unexpected event!"),
4682                 }
4683         }
4684 }
4685
4686 macro_rules! check_spendable_outputs {
4687         ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4688                 {
4689                         let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4690                         let mut txn = Vec::new();
4691                         let mut all_outputs = Vec::new();
4692                         let secp_ctx = Secp256k1::new();
4693                         for event in events.drain(..) {
4694                                 match event {
4695                                         Event::SpendableOutputs { mut outputs } => {
4696                                                 for outp in outputs.drain(..) {
4697                                                         let mut outputs = vec![outp];
4698                                                         txn.push($keysinterface.backing.spend_spendable_outputs(&outputs, Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4699                                                         all_outputs.push(outputs.pop().unwrap());
4700                                                 }
4701                                         },
4702                                         _ => panic!("Unexpected event"),
4703                                 };
4704                         }
4705                         if all_outputs.len() > 1 {
4706                                 if let Ok(tx) = $keysinterface.backing.spend_spendable_outputs(&all_outputs, Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx) {
4707                                         txn.push(tx);
4708                                 }
4709                         }
4710                         txn
4711                 }
4712         }
4713 }
4714
4715 #[test]
4716 fn test_claim_sizeable_push_msat() {
4717         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4718         let chanmon_cfgs = create_chanmon_cfgs(2);
4719         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4720         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4721         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4722
4723         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4724         nodes[1].node.force_close_channel(&chan.2).unwrap();
4725         check_closed_broadcast!(nodes[1], false);
4726         check_added_monitors!(nodes[1], 1);
4727         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4728         assert_eq!(node_txn.len(), 1);
4729         check_spends!(node_txn[0], chan.3);
4730         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
4731
4732         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4733         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4734         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
4735
4736         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4737         assert_eq!(spend_txn.len(), 1);
4738         check_spends!(spend_txn[0], node_txn[0]);
4739 }
4740
4741 #[test]
4742 fn test_claim_on_remote_sizeable_push_msat() {
4743         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4744         // to_remote output is encumbered by a P2WPKH
4745         let chanmon_cfgs = create_chanmon_cfgs(2);
4746         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4747         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4748         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4749
4750         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4751         nodes[0].node.force_close_channel(&chan.2).unwrap();
4752         check_closed_broadcast!(nodes[0], false);
4753         check_added_monitors!(nodes[0], 1);
4754
4755         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4756         assert_eq!(node_txn.len(), 1);
4757         check_spends!(node_txn[0], chan.3);
4758         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
4759
4760         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4761         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4762         check_closed_broadcast!(nodes[1], false);
4763         check_added_monitors!(nodes[1], 1);
4764         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
4765
4766         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4767         assert_eq!(spend_txn.len(), 1);
4768         check_spends!(spend_txn[0], node_txn[0]);
4769 }
4770
4771 #[test]
4772 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4773         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4774         // to_remote output is encumbered by a P2WPKH
4775
4776         let chanmon_cfgs = create_chanmon_cfgs(2);
4777         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4778         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4779         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4780
4781         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4782         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4783         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4784         assert_eq!(revoked_local_txn[0].input.len(), 1);
4785         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4786
4787         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4788         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4789         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4790         check_closed_broadcast!(nodes[1], false);
4791         check_added_monitors!(nodes[1], 1);
4792
4793         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4794         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4795         connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4796         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
4797
4798         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4799         assert_eq!(spend_txn.len(), 3);
4800         check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4801         check_spends!(spend_txn[1], node_txn[0]);
4802         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4803 }
4804
4805 #[test]
4806 fn test_static_spendable_outputs_preimage_tx() {
4807         let chanmon_cfgs = create_chanmon_cfgs(2);
4808         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4809         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4810         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4811
4812         // Create some initial channels
4813         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4814
4815         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4816
4817         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4818         assert_eq!(commitment_tx[0].input.len(), 1);
4819         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4820
4821         // Settle A's commitment tx on B's chain
4822         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4823         assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
4824         check_added_monitors!(nodes[1], 1);
4825         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
4826         check_added_monitors!(nodes[1], 1);
4827         let events = nodes[1].node.get_and_clear_pending_msg_events();
4828         match events[0] {
4829                 MessageSendEvent::UpdateHTLCs { .. } => {},
4830                 _ => panic!("Unexpected event"),
4831         }
4832         match events[1] {
4833                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4834                 _ => panic!("Unexepected event"),
4835         }
4836
4837         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4838         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4839         assert_eq!(node_txn.len(), 3);
4840         check_spends!(node_txn[0], commitment_tx[0]);
4841         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4842         check_spends!(node_txn[1], chan_1.3);
4843         check_spends!(node_txn[2], node_txn[1]);
4844
4845         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4846         connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4847         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
4848
4849         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4850         assert_eq!(spend_txn.len(), 1);
4851         check_spends!(spend_txn[0], node_txn[0]);
4852 }
4853
4854 #[test]
4855 fn test_static_spendable_outputs_timeout_tx() {
4856         let chanmon_cfgs = create_chanmon_cfgs(2);
4857         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4858         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4859         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4860
4861         // Create some initial channels
4862         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4863
4864         // Rebalance the network a bit by relaying one payment through all the channels ...
4865         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4866
4867         let (_, our_payment_hash) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4868
4869         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4870         assert_eq!(commitment_tx[0].input.len(), 1);
4871         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4872
4873         // Settle A's commitment tx on B' chain
4874         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4875         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()] }, 0);
4876         check_added_monitors!(nodes[1], 1);
4877         let events = nodes[1].node.get_and_clear_pending_msg_events();
4878         match events[0] {
4879                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4880                 _ => panic!("Unexpected event"),
4881         }
4882
4883         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4884         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4885         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4886         check_spends!(node_txn[0],  commitment_tx[0].clone());
4887         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4888         check_spends!(node_txn[1], chan_1.3.clone());
4889         check_spends!(node_txn[2], node_txn[1]);
4890
4891         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4892         connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4893         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
4894         expect_payment_failed!(nodes[1], our_payment_hash, true);
4895
4896         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4897         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
4898         check_spends!(spend_txn[0], commitment_tx[0]);
4899         check_spends!(spend_txn[1], node_txn[0]);
4900         check_spends!(spend_txn[2], node_txn[0], commitment_tx[0]); // All outputs
4901 }
4902
4903 #[test]
4904 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4905         let chanmon_cfgs = create_chanmon_cfgs(2);
4906         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4907         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4908         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4909
4910         // Create some initial channels
4911         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4912
4913         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4914         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4915         assert_eq!(revoked_local_txn[0].input.len(), 1);
4916         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4917
4918         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4919
4920         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4921         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4922         check_closed_broadcast!(nodes[1], false);
4923         check_added_monitors!(nodes[1], 1);
4924
4925         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4926         assert_eq!(node_txn.len(), 2);
4927         assert_eq!(node_txn[0].input.len(), 2);
4928         check_spends!(node_txn[0], revoked_local_txn[0]);
4929
4930         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4931         connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4932         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
4933
4934         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4935         assert_eq!(spend_txn.len(), 1);
4936         check_spends!(spend_txn[0], node_txn[0]);
4937 }
4938
4939 #[test]
4940 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4941         let mut chanmon_cfgs = create_chanmon_cfgs(2);
4942         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
4943         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4944         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4945         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4946
4947         // Create some initial channels
4948         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4949
4950         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4951         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4952         assert_eq!(revoked_local_txn[0].input.len(), 1);
4953         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4954
4955         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4956
4957         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4958         // A will generate HTLC-Timeout from revoked commitment tx
4959         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4960         check_closed_broadcast!(nodes[0], false);
4961         check_added_monitors!(nodes[0], 1);
4962
4963         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4964         assert_eq!(revoked_htlc_txn.len(), 2);
4965         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4966         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4967         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4968         check_spends!(revoked_htlc_txn[1], chan_1.3);
4969
4970         // B will generate justice tx from A's revoked commitment/HTLC tx
4971         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 0);
4972         check_closed_broadcast!(nodes[1], false);
4973         check_added_monitors!(nodes[1], 1);
4974
4975         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4976         assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
4977         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4978         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
4979         // transactions next...
4980         assert_eq!(node_txn[0].input.len(), 3);
4981         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4982
4983         assert_eq!(node_txn[1].input.len(), 2);
4984         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[0]);
4985         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4986                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4987         } else {
4988                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
4989                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4990         }
4991
4992         assert_eq!(node_txn[2].input.len(), 1);
4993         check_spends!(node_txn[2], chan_1.3);
4994
4995         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4996         connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[1].clone()] }, 1);
4997         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
4998
4999         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5000         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5001         assert_eq!(spend_txn.len(), 1);
5002         assert_eq!(spend_txn[0].input.len(), 1);
5003         check_spends!(spend_txn[0], node_txn[1]);
5004 }
5005
5006 #[test]
5007 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5008         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5009         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
5010         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5011         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5012         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5013
5014         // Create some initial channels
5015         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5016
5017         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5018         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5019         assert_eq!(revoked_local_txn[0].input.len(), 1);
5020         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5021
5022         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5023         assert_eq!(revoked_local_txn[0].output.len(), 2);
5024
5025         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
5026
5027         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5028         // B will generate HTLC-Success from revoked commitment tx
5029         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5030         check_closed_broadcast!(nodes[1], false);
5031         check_added_monitors!(nodes[1], 1);
5032         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5033
5034         assert_eq!(revoked_htlc_txn.len(), 2);
5035         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5036         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5037         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5038
5039         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5040         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5041         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5042
5043         // A will generate justice tx from B's revoked commitment/HTLC tx
5044         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
5045         check_closed_broadcast!(nodes[0], false);
5046         check_added_monitors!(nodes[0], 1);
5047
5048         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5049         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5050
5051         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5052         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5053         // transactions next...
5054         assert_eq!(node_txn[0].input.len(), 2);
5055         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5056         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5057                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5058         } else {
5059                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5060                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5061         }
5062
5063         assert_eq!(node_txn[1].input.len(), 1);
5064         check_spends!(node_txn[1], revoked_htlc_txn[0]);
5065
5066         check_spends!(node_txn[2], chan_1.3);
5067
5068         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5069         connect_block(&nodes[0], &Block { header: header_1, txdata: vec![node_txn[1].clone()] }, 1);
5070         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
5071
5072         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5073         // didn't try to generate any new transactions.
5074
5075         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5076         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5077         assert_eq!(spend_txn.len(), 3);
5078         assert_eq!(spend_txn[0].input.len(), 1);
5079         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5080         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5081         check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5082         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5083 }
5084
5085 #[test]
5086 fn test_onchain_to_onchain_claim() {
5087         // Test that in case of channel closure, we detect the state of output and claim HTLC
5088         // on downstream peer's remote commitment tx.
5089         // First, have C claim an HTLC against its own latest commitment transaction.
5090         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5091         // channel.
5092         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5093         // gets broadcast.
5094
5095         let chanmon_cfgs = create_chanmon_cfgs(3);
5096         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5097         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5098         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5099
5100         // Create some initial channels
5101         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5102         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5103
5104         // Rebalance the network a bit by relaying one payment through all the channels ...
5105         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5106         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5107
5108         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5109         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5110         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5111         check_spends!(commitment_tx[0], chan_2.3);
5112         nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
5113         check_added_monitors!(nodes[2], 1);
5114         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5115         assert!(updates.update_add_htlcs.is_empty());
5116         assert!(updates.update_fail_htlcs.is_empty());
5117         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5118         assert!(updates.update_fail_malformed_htlcs.is_empty());
5119
5120         connect_block(&nodes[2], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5121         check_closed_broadcast!(nodes[2], false);
5122         check_added_monitors!(nodes[2], 1);
5123
5124         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5125         assert_eq!(c_txn.len(), 3);
5126         assert_eq!(c_txn[0], c_txn[2]);
5127         assert_eq!(commitment_tx[0], c_txn[1]);
5128         check_spends!(c_txn[1], chan_2.3);
5129         check_spends!(c_txn[2], c_txn[1]);
5130         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5131         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5132         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5133         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5134
5135         // 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
5136         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
5137         {
5138                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5139                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
5140                 assert_eq!(b_txn.len(), 3);
5141                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
5142                 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5143                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5144                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5145                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5146                 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5147                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5148                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5149                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5150                 b_txn.clear();
5151         }
5152         check_added_monitors!(nodes[1], 1);
5153         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5154         check_added_monitors!(nodes[1], 1);
5155         match msg_events[0] {
5156                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
5157                 _ => panic!("Unexpected event"),
5158         }
5159         match msg_events[1] {
5160                 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, .. } } => {
5161                         assert!(update_add_htlcs.is_empty());
5162                         assert!(update_fail_htlcs.is_empty());
5163                         assert_eq!(update_fulfill_htlcs.len(), 1);
5164                         assert!(update_fail_malformed_htlcs.is_empty());
5165                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5166                 },
5167                 _ => panic!("Unexpected event"),
5168         };
5169         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5170         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5171         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5172         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5173         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5174         assert_eq!(b_txn.len(), 3);
5175         check_spends!(b_txn[1], chan_1.3);
5176         check_spends!(b_txn[2], b_txn[1]);
5177         check_spends!(b_txn[0], commitment_tx[0]);
5178         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5179         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5180         assert_eq!(b_txn[0].lock_time, 0); // Success tx
5181
5182         check_closed_broadcast!(nodes[1], false);
5183         check_added_monitors!(nodes[1], 1);
5184 }
5185
5186 #[test]
5187 fn test_duplicate_payment_hash_one_failure_one_success() {
5188         // Topology : A --> B --> C
5189         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5190         let chanmon_cfgs = create_chanmon_cfgs(3);
5191         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5192         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5193         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5194
5195         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5196         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5197
5198         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5199         *nodes[0].network_payment_count.borrow_mut() -= 1;
5200         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
5201
5202         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5203         assert_eq!(commitment_txn[0].input.len(), 1);
5204         check_spends!(commitment_txn[0], chan_2.3);
5205
5206         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5207         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5208         check_closed_broadcast!(nodes[1], false);
5209         check_added_monitors!(nodes[1], 1);
5210
5211         let htlc_timeout_tx;
5212         { // Extract one of the two HTLC-Timeout transaction
5213                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5214                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
5215                 assert_eq!(node_txn.len(), 5);
5216                 check_spends!(node_txn[0], commitment_txn[0]);
5217                 assert_eq!(node_txn[0].input.len(), 1);
5218                 check_spends!(node_txn[1], commitment_txn[0]);
5219                 assert_eq!(node_txn[1].input.len(), 1);
5220                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5221                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5222                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5223                 check_spends!(node_txn[2], chan_2.3);
5224                 check_spends!(node_txn[3], node_txn[2]);
5225                 check_spends!(node_txn[4], node_txn[2]);
5226                 htlc_timeout_tx = node_txn[1].clone();
5227         }
5228
5229         nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
5230         connect_block(&nodes[2], &Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5231         check_added_monitors!(nodes[2], 3);
5232         let events = nodes[2].node.get_and_clear_pending_msg_events();
5233         match events[0] {
5234                 MessageSendEvent::UpdateHTLCs { .. } => {},
5235                 _ => panic!("Unexpected event"),
5236         }
5237         match events[1] {
5238                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5239                 _ => panic!("Unexepected event"),
5240         }
5241         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5242         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)
5243         check_spends!(htlc_success_txn[2], chan_2.3);
5244         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
5245         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
5246         assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5247         assert_eq!(htlc_success_txn[0].input.len(), 1);
5248         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5249         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5250         assert_eq!(htlc_success_txn[1].input.len(), 1);
5251         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5252         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5253         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5254         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5255
5256         connect_block(&nodes[1], &Block { header, txdata: vec![htlc_timeout_tx] }, 200);
5257         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 200, true, header.block_hash());
5258         expect_pending_htlcs_forwardable!(nodes[1]);
5259         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5260         assert!(htlc_updates.update_add_htlcs.is_empty());
5261         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5262         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
5263         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5264         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5265         check_added_monitors!(nodes[1], 1);
5266
5267         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5268         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5269         {
5270                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5271                 let events = nodes[0].node.get_and_clear_pending_msg_events();
5272                 assert_eq!(events.len(), 1);
5273                 match events[0] {
5274                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
5275                         },
5276                         _ => { panic!("Unexpected event"); }
5277                 }
5278         }
5279         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5280
5281         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5282         connect_block(&nodes[1], &Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
5283         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5284         assert!(updates.update_add_htlcs.is_empty());
5285         assert!(updates.update_fail_htlcs.is_empty());
5286         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5287         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
5288         assert!(updates.update_fail_malformed_htlcs.is_empty());
5289         check_added_monitors!(nodes[1], 1);
5290
5291         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5292         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5293
5294         let events = nodes[0].node.get_and_clear_pending_events();
5295         match events[0] {
5296                 Event::PaymentSent { ref payment_preimage } => {
5297                         assert_eq!(*payment_preimage, our_payment_preimage);
5298                 }
5299                 _ => panic!("Unexpected event"),
5300         }
5301 }
5302
5303 #[test]
5304 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5305         let chanmon_cfgs = create_chanmon_cfgs(2);
5306         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5307         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5308         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5309
5310         // Create some initial channels
5311         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5312
5313         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5314         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5315         assert_eq!(local_txn.len(), 1);
5316         assert_eq!(local_txn[0].input.len(), 1);
5317         check_spends!(local_txn[0], chan_1.3);
5318
5319         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5320         nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
5321         check_added_monitors!(nodes[1], 1);
5322         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5323         connect_block(&nodes[1], &Block { header, txdata: vec![local_txn[0].clone()] }, 1);
5324         check_added_monitors!(nodes[1], 1);
5325         let events = nodes[1].node.get_and_clear_pending_msg_events();
5326         match events[0] {
5327                 MessageSendEvent::UpdateHTLCs { .. } => {},
5328                 _ => panic!("Unexpected event"),
5329         }
5330         match events[1] {
5331                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5332                 _ => panic!("Unexepected event"),
5333         }
5334         let node_txn = {
5335                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5336                 assert_eq!(node_txn.len(), 3);
5337                 assert_eq!(node_txn[0], node_txn[2]);
5338                 assert_eq!(node_txn[1], local_txn[0]);
5339                 assert_eq!(node_txn[0].input.len(), 1);
5340                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5341                 check_spends!(node_txn[0], local_txn[0]);
5342                 vec![node_txn[0].clone()]
5343         };
5344
5345         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5346         connect_block(&nodes[1], &Block { header: header_201, txdata: node_txn.clone() }, 201);
5347         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 201, true, header_201.block_hash());
5348
5349         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5350         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5351         assert_eq!(spend_txn.len(), 1);
5352         check_spends!(spend_txn[0], node_txn[0]);
5353 }
5354
5355 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5356         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5357         // unrevoked commitment transaction.
5358         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5359         // a remote RAA before they could be failed backwards (and combinations thereof).
5360         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5361         // use the same payment hashes.
5362         // Thus, we use a six-node network:
5363         //
5364         // A \         / E
5365         //    - C - D -
5366         // B /         \ F
5367         // And test where C fails back to A/B when D announces its latest commitment transaction
5368         let chanmon_cfgs = create_chanmon_cfgs(6);
5369         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5370         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5371         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5372         let logger = test_utils::TestLogger::new();
5373
5374         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5375         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5376         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5377         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5378         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5379
5380         // Rebalance and check output sanity...
5381         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
5382         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
5383         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5384
5385         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5386         // 0th HTLC:
5387         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
5388         // 1st HTLC:
5389         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
5390         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5391         let our_node_id = &nodes[1].node.get_our_node_id();
5392         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5393         // 2nd HTLC:
5394         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], ds_dust_limit*1000, payment_hash_1); // not added < dust limit + HTLC tx fee
5395         // 3rd HTLC:
5396         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], ds_dust_limit*1000, payment_hash_2); // not added < dust limit + HTLC tx fee
5397         // 4th HTLC:
5398         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5399         // 5th HTLC:
5400         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5401         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5402         // 6th HTLC:
5403         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
5404         // 7th HTLC:
5405         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
5406
5407         // 8th HTLC:
5408         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5409         // 9th HTLC:
5410         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5411         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], ds_dust_limit*1000, payment_hash_5); // not added < dust limit + HTLC tx fee
5412
5413         // 10th HTLC:
5414         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
5415         // 11th HTLC:
5416         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5417         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
5418
5419         // Double-check that six of the new HTLC were added
5420         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5421         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5422         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5423         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5424
5425         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5426         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5427         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
5428         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
5429         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
5430         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
5431         check_added_monitors!(nodes[4], 0);
5432         expect_pending_htlcs_forwardable!(nodes[4]);
5433         check_added_monitors!(nodes[4], 1);
5434
5435         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5436         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5437         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5438         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5439         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5440         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5441
5442         // Fail 3rd below-dust and 7th above-dust HTLCs
5443         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
5444         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
5445         check_added_monitors!(nodes[5], 0);
5446         expect_pending_htlcs_forwardable!(nodes[5]);
5447         check_added_monitors!(nodes[5], 1);
5448
5449         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5450         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5451         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5452         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5453
5454         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5455
5456         expect_pending_htlcs_forwardable!(nodes[3]);
5457         check_added_monitors!(nodes[3], 1);
5458         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5459         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5460         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5461         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5462         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5463         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5464         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5465         if deliver_last_raa {
5466                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5467         } else {
5468                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5469         }
5470
5471         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5472         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5473         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5474         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5475         //
5476         // We now broadcast the latest commitment transaction, which *should* result in failures for
5477         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5478         // the non-broadcast above-dust HTLCs.
5479         //
5480         // Alternatively, we may broadcast the previous commitment transaction, which should only
5481         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5482         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5483
5484         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5485         if announce_latest {
5486                 connect_block(&nodes[2], &Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
5487         } else {
5488                 connect_block(&nodes[2], &Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
5489         }
5490         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1, 1, true,  header.block_hash());
5491         check_closed_broadcast!(nodes[2], false);
5492         expect_pending_htlcs_forwardable!(nodes[2]);
5493         check_added_monitors!(nodes[2], 3);
5494
5495         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5496         assert_eq!(cs_msgs.len(), 2);
5497         let mut a_done = false;
5498         for msg in cs_msgs {
5499                 match msg {
5500                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5501                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5502                                 // should be failed-backwards here.
5503                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5504                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5505                                         for htlc in &updates.update_fail_htlcs {
5506                                                 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 });
5507                                         }
5508                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5509                                         assert!(!a_done);
5510                                         a_done = true;
5511                                         &nodes[0]
5512                                 } else {
5513                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5514                                         for htlc in &updates.update_fail_htlcs {
5515                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5516                                         }
5517                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5518                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5519                                         &nodes[1]
5520                                 };
5521                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5522                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5523                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5524                                 if announce_latest {
5525                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5526                                         if *node_id == nodes[0].node.get_our_node_id() {
5527                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5528                                         }
5529                                 }
5530                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5531                         },
5532                         _ => panic!("Unexpected event"),
5533                 }
5534         }
5535
5536         let as_events = nodes[0].node.get_and_clear_pending_events();
5537         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5538         let mut as_failds = HashSet::new();
5539         for event in as_events.iter() {
5540                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5541                         assert!(as_failds.insert(*payment_hash));
5542                         if *payment_hash != payment_hash_2 {
5543                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5544                         } else {
5545                                 assert!(!rejected_by_dest);
5546                         }
5547                 } else { panic!("Unexpected event"); }
5548         }
5549         assert!(as_failds.contains(&payment_hash_1));
5550         assert!(as_failds.contains(&payment_hash_2));
5551         if announce_latest {
5552                 assert!(as_failds.contains(&payment_hash_3));
5553                 assert!(as_failds.contains(&payment_hash_5));
5554         }
5555         assert!(as_failds.contains(&payment_hash_6));
5556
5557         let bs_events = nodes[1].node.get_and_clear_pending_events();
5558         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5559         let mut bs_failds = HashSet::new();
5560         for event in bs_events.iter() {
5561                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5562                         assert!(bs_failds.insert(*payment_hash));
5563                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5564                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5565                         } else {
5566                                 assert!(!rejected_by_dest);
5567                         }
5568                 } else { panic!("Unexpected event"); }
5569         }
5570         assert!(bs_failds.contains(&payment_hash_1));
5571         assert!(bs_failds.contains(&payment_hash_2));
5572         if announce_latest {
5573                 assert!(bs_failds.contains(&payment_hash_4));
5574         }
5575         assert!(bs_failds.contains(&payment_hash_5));
5576
5577         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5578         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5579         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5580         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5581         // PaymentFailureNetworkUpdates.
5582         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5583         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5584         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5585         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5586         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5587                 match event {
5588                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5589                         _ => panic!("Unexpected event"),
5590                 }
5591         }
5592 }
5593
5594 #[test]
5595 fn test_fail_backwards_latest_remote_announce_a() {
5596         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5597 }
5598
5599 #[test]
5600 fn test_fail_backwards_latest_remote_announce_b() {
5601         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5602 }
5603
5604 #[test]
5605 fn test_fail_backwards_previous_remote_announce() {
5606         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5607         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5608         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5609 }
5610
5611 #[test]
5612 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5613         let chanmon_cfgs = create_chanmon_cfgs(2);
5614         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5615         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5616         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5617
5618         // Create some initial channels
5619         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5620
5621         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5622         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5623         assert_eq!(local_txn[0].input.len(), 1);
5624         check_spends!(local_txn[0], chan_1.3);
5625
5626         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5627         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5628         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] }, 200);
5629         check_closed_broadcast!(nodes[0], false);
5630         check_added_monitors!(nodes[0], 1);
5631
5632         let htlc_timeout = {
5633                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5634                 assert_eq!(node_txn[0].input.len(), 1);
5635                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5636                 check_spends!(node_txn[0], local_txn[0]);
5637                 node_txn[0].clone()
5638         };
5639
5640         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5641         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5642         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 201, true, header_201.block_hash());
5643         expect_payment_failed!(nodes[0], our_payment_hash, true);
5644
5645         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5646         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5647         assert_eq!(spend_txn.len(), 3);
5648         check_spends!(spend_txn[0], local_txn[0]);
5649         check_spends!(spend_txn[1], htlc_timeout);
5650         check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5651 }
5652
5653 #[test]
5654 fn test_key_derivation_params() {
5655         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5656         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5657         // let us re-derive the channel key set to then derive a delayed_payment_key.
5658
5659         let chanmon_cfgs = create_chanmon_cfgs(3);
5660
5661         // We manually create the node configuration to backup the seed.
5662         let seed = [42; 32];
5663         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5664         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);
5665         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 };
5666         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5667         node_cfgs.remove(0);
5668         node_cfgs.insert(0, node);
5669
5670         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5671         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5672
5673         // Create some initial channels
5674         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5675         // for node 0
5676         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5677         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5678         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5679
5680         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5681         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5682         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5683         assert_eq!(local_txn_1[0].input.len(), 1);
5684         check_spends!(local_txn_1[0], chan_1.3);
5685
5686         // We check funding pubkey are unique
5687         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]));
5688         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]));
5689         if from_0_funding_key_0 == from_1_funding_key_0
5690             || from_0_funding_key_0 == from_1_funding_key_1
5691             || from_0_funding_key_1 == from_1_funding_key_0
5692             || from_0_funding_key_1 == from_1_funding_key_1 {
5693                 panic!("Funding pubkeys aren't unique");
5694         }
5695
5696         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5697         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5698         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn_1[0].clone()] }, 200);
5699         check_closed_broadcast!(nodes[0], false);
5700         check_added_monitors!(nodes[0], 1);
5701
5702         let htlc_timeout = {
5703                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5704                 assert_eq!(node_txn[0].input.len(), 1);
5705                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5706                 check_spends!(node_txn[0], local_txn_1[0]);
5707                 node_txn[0].clone()
5708         };
5709
5710         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5711         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5712         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 201, true, header_201.block_hash());
5713         expect_payment_failed!(nodes[0], our_payment_hash, true);
5714
5715         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5716         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5717         let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5718         assert_eq!(spend_txn.len(), 3);
5719         check_spends!(spend_txn[0], local_txn_1[0]);
5720         check_spends!(spend_txn[1], htlc_timeout);
5721         check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5722 }
5723
5724 #[test]
5725 fn test_static_output_closing_tx() {
5726         let chanmon_cfgs = create_chanmon_cfgs(2);
5727         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5728         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5729         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5730
5731         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5732
5733         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5734         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5735
5736         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5737         connect_block(&nodes[0], &Block { header, txdata: vec![closing_tx.clone()] }, 0);
5738         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 0, true, header.block_hash());
5739
5740         let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5741         assert_eq!(spend_txn.len(), 1);
5742         check_spends!(spend_txn[0], closing_tx);
5743
5744         connect_block(&nodes[1], &Block { header, txdata: vec![closing_tx.clone()] }, 0);
5745         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 0, true, header.block_hash());
5746
5747         let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5748         assert_eq!(spend_txn.len(), 1);
5749         check_spends!(spend_txn[0], closing_tx);
5750 }
5751
5752 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5753         let chanmon_cfgs = create_chanmon_cfgs(2);
5754         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5755         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5756         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5757         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5758
5759         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5760
5761         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5762         // present in B's local commitment transaction, but none of A's commitment transactions.
5763         assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
5764         check_added_monitors!(nodes[1], 1);
5765
5766         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5767         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5768         let events = nodes[0].node.get_and_clear_pending_events();
5769         assert_eq!(events.len(), 1);
5770         match events[0] {
5771                 Event::PaymentSent { payment_preimage } => {
5772                         assert_eq!(payment_preimage, our_payment_preimage);
5773                 },
5774                 _ => panic!("Unexpected event"),
5775         }
5776
5777         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5778         check_added_monitors!(nodes[0], 1);
5779         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5780         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5781         check_added_monitors!(nodes[1], 1);
5782
5783         let mut block = Block {
5784                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5785                 txdata: vec![],
5786         };
5787         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
5788                 connect_block(&nodes[1], &block, i);
5789                 block.header.prev_blockhash = block.block_hash();
5790         }
5791         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5792         check_closed_broadcast!(nodes[1], false);
5793         check_added_monitors!(nodes[1], 1);
5794 }
5795
5796 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5797         let chanmon_cfgs = create_chanmon_cfgs(2);
5798         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5799         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5800         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5801         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5802         let logger = test_utils::TestLogger::new();
5803
5804         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5805         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5806         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(), None, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV, &logger).unwrap();
5807         nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
5808         check_added_monitors!(nodes[0], 1);
5809
5810         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5811
5812         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5813         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5814         // to "time out" the HTLC.
5815
5816         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5817
5818         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5819                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()}, i);
5820                 header.prev_blockhash = header.block_hash();
5821         }
5822         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5823         check_closed_broadcast!(nodes[0], false);
5824         check_added_monitors!(nodes[0], 1);
5825 }
5826
5827 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5828         let chanmon_cfgs = create_chanmon_cfgs(3);
5829         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5830         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5831         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5832         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5833
5834         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5835         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5836         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5837         // actually revoked.
5838         let htlc_value = if use_dust { 50000 } else { 3000000 };
5839         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5840         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
5841         expect_pending_htlcs_forwardable!(nodes[1]);
5842         check_added_monitors!(nodes[1], 1);
5843
5844         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5845         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5846         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5847         check_added_monitors!(nodes[0], 1);
5848         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5849         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5850         check_added_monitors!(nodes[1], 1);
5851         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5852         check_added_monitors!(nodes[1], 1);
5853         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5854
5855         if check_revoke_no_close {
5856                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5857                 check_added_monitors!(nodes[0], 1);
5858         }
5859
5860         let mut block = Block {
5861                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5862                 txdata: vec![],
5863         };
5864         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5865                 connect_block(&nodes[0], &block, i);
5866                 block.header.prev_blockhash = block.block_hash();
5867         }
5868         if !check_revoke_no_close {
5869                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5870                 check_closed_broadcast!(nodes[0], false);
5871                 check_added_monitors!(nodes[0], 1);
5872         } else {
5873                 expect_payment_failed!(nodes[0], our_payment_hash, true);
5874         }
5875 }
5876
5877 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5878 // There are only a few cases to test here:
5879 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5880 //    broadcastable commitment transactions result in channel closure,
5881 //  * its included in an unrevoked-but-previous remote commitment transaction,
5882 //  * its included in the latest remote or local commitment transactions.
5883 // We test each of the three possible commitment transactions individually and use both dust and
5884 // non-dust HTLCs.
5885 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5886 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5887 // tested for at least one of the cases in other tests.
5888 #[test]
5889 fn htlc_claim_single_commitment_only_a() {
5890         do_htlc_claim_local_commitment_only(true);
5891         do_htlc_claim_local_commitment_only(false);
5892
5893         do_htlc_claim_current_remote_commitment_only(true);
5894         do_htlc_claim_current_remote_commitment_only(false);
5895 }
5896
5897 #[test]
5898 fn htlc_claim_single_commitment_only_b() {
5899         do_htlc_claim_previous_remote_commitment_only(true, false);
5900         do_htlc_claim_previous_remote_commitment_only(false, false);
5901         do_htlc_claim_previous_remote_commitment_only(true, true);
5902         do_htlc_claim_previous_remote_commitment_only(false, true);
5903 }
5904
5905 #[test]
5906 #[should_panic]
5907 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5908         let chanmon_cfgs = create_chanmon_cfgs(2);
5909         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5910         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5911         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5912         //Force duplicate channel ids
5913         for node in nodes.iter() {
5914                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5915         }
5916
5917         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5918         let channel_value_satoshis=10000;
5919         let push_msat=10001;
5920         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5921         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5922         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
5923
5924         //Create a second channel with a channel_id collision
5925         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5926 }
5927
5928 #[test]
5929 fn bolt2_open_channel_sending_node_checks_part2() {
5930         let chanmon_cfgs = create_chanmon_cfgs(2);
5931         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5932         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5933         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5934
5935         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5936         let channel_value_satoshis=2^24;
5937         let push_msat=10001;
5938         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5939
5940         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5941         let channel_value_satoshis=10000;
5942         // Test when push_msat is equal to 1000 * funding_satoshis.
5943         let push_msat=1000*channel_value_satoshis+1;
5944         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5945
5946         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5947         let channel_value_satoshis=10000;
5948         let push_msat=10001;
5949         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
5950         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5951         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5952
5953         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5954         // 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
5955         assert!(node0_to_1_send_open_channel.channel_flags<=1);
5956
5957         // 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.
5958         assert!(BREAKDOWN_TIMEOUT>0);
5959         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5960
5961         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5962         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
5963         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5964
5965         // 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.
5966         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5967         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5968         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5969         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
5970         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5971 }
5972
5973 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
5974 // originated from our node, its failure is surfaced to the user. We trigger this failure to
5975 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
5976 // is no longer affordable once it's freed.
5977 #[test]
5978 fn test_fail_holding_cell_htlc_upon_free() {
5979         let chanmon_cfgs = create_chanmon_cfgs(2);
5980         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5981         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5982         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5983         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
5984         let logger = test_utils::TestLogger::new();
5985
5986         // First nodes[0] generates an update_fee, setting the channel's
5987         // pending_update_fee.
5988         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
5989         check_added_monitors!(nodes[0], 1);
5990
5991         let events = nodes[0].node.get_and_clear_pending_msg_events();
5992         assert_eq!(events.len(), 1);
5993         let (update_msg, commitment_signed) = match events[0] {
5994                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5995                         (update_fee.as_ref(), commitment_signed)
5996                 },
5997                 _ => panic!("Unexpected event"),
5998         };
5999
6000         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6001
6002         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6003         let channel_reserve = chan_stat.channel_reserve_msat;
6004         let feerate = get_feerate!(nodes[0], chan.2);
6005
6006         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6007         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6008         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6009         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6010         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(), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6011
6012         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6013         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6014         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6015         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6016
6017         // Flush the pending fee update.
6018         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6019         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6020         check_added_monitors!(nodes[1], 1);
6021         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6022         check_added_monitors!(nodes[0], 1);
6023
6024         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6025         // HTLC, but now that the fee has been raised the payment will now fail, causing
6026         // us to surface its failure to the user.
6027         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6028         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6029         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 1 HTLC updates".to_string(), 1);
6030         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);
6031         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6032
6033         // Check that the payment failed to be sent out.
6034         let events = nodes[0].node.get_and_clear_pending_events();
6035         assert_eq!(events.len(), 1);
6036         match &events[0] {
6037                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6038                         assert_eq!(our_payment_hash.clone(), *payment_hash);
6039                         assert_eq!(*rejected_by_dest, false);
6040                         assert_eq!(*error_code, None);
6041                         assert_eq!(*error_data, None);
6042                 },
6043                 _ => panic!("Unexpected event"),
6044         }
6045 }
6046
6047 // Test that if multiple HTLCs are released from the holding cell and one is
6048 // valid but the other is no longer valid upon release, the valid HTLC can be
6049 // successfully completed while the other one fails as expected.
6050 #[test]
6051 fn test_free_and_fail_holding_cell_htlcs() {
6052         let chanmon_cfgs = create_chanmon_cfgs(2);
6053         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6054         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6055         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6056         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6057         let logger = test_utils::TestLogger::new();
6058
6059         // First nodes[0] generates an update_fee, setting the channel's
6060         // pending_update_fee.
6061         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6062         check_added_monitors!(nodes[0], 1);
6063
6064         let events = nodes[0].node.get_and_clear_pending_msg_events();
6065         assert_eq!(events.len(), 1);
6066         let (update_msg, commitment_signed) = match events[0] {
6067                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6068                         (update_fee.as_ref(), commitment_signed)
6069                 },
6070                 _ => panic!("Unexpected event"),
6071         };
6072
6073         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6074
6075         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6076         let channel_reserve = chan_stat.channel_reserve_msat;
6077         let feerate = get_feerate!(nodes[0], chan.2);
6078
6079         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6080         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
6081         let amt_1 = 20000;
6082         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
6083         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6084         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6085         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(), None, &[], amt_1, TEST_FINAL_CLTV, &logger).unwrap();
6086         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(), None, &[], amt_2, TEST_FINAL_CLTV, &logger).unwrap();
6087
6088         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6089         nodes[0].node.send_payment(&route_1, payment_hash_1, &None).unwrap();
6090         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6091         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6092         nodes[0].node.send_payment(&route_2, payment_hash_2, &None).unwrap();
6093         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6094         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6095
6096         // Flush the pending fee update.
6097         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6098         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6099         check_added_monitors!(nodes[1], 1);
6100         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6101         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6102         check_added_monitors!(nodes[0], 2);
6103
6104         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6105         // but now that the fee has been raised the second payment will now fail, causing us
6106         // to surface its failure to the user. The first payment should succeed.
6107         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6108         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6109         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 2 HTLC updates".to_string(), 1);
6110         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);
6111         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6112
6113         // Check that the second payment failed to be sent out.
6114         let events = nodes[0].node.get_and_clear_pending_events();
6115         assert_eq!(events.len(), 1);
6116         match &events[0] {
6117                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6118                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6119                         assert_eq!(*rejected_by_dest, false);
6120                         assert_eq!(*error_code, None);
6121                         assert_eq!(*error_data, None);
6122                 },
6123                 _ => panic!("Unexpected event"),
6124         }
6125
6126         // Complete the first payment and the RAA from the fee update.
6127         let (payment_event, send_raa_event) = {
6128                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6129                 assert_eq!(msgs.len(), 2);
6130                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6131         };
6132         let raa = match send_raa_event {
6133                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6134                 _ => panic!("Unexpected event"),
6135         };
6136         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6137         check_added_monitors!(nodes[1], 1);
6138         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6139         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6140         let events = nodes[1].node.get_and_clear_pending_events();
6141         assert_eq!(events.len(), 1);
6142         match events[0] {
6143                 Event::PendingHTLCsForwardable { .. } => {},
6144                 _ => panic!("Unexpected event"),
6145         }
6146         nodes[1].node.process_pending_htlc_forwards();
6147         let events = nodes[1].node.get_and_clear_pending_events();
6148         assert_eq!(events.len(), 1);
6149         match events[0] {
6150                 Event::PaymentReceived { .. } => {},
6151                 _ => panic!("Unexpected event"),
6152         }
6153         nodes[1].node.claim_funds(payment_preimage_1, &None, amt_1);
6154         check_added_monitors!(nodes[1], 1);
6155         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6156         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6157         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6158         let events = nodes[0].node.get_and_clear_pending_events();
6159         assert_eq!(events.len(), 1);
6160         match events[0] {
6161                 Event::PaymentSent { ref payment_preimage } => {
6162                         assert_eq!(*payment_preimage, payment_preimage_1);
6163                 }
6164                 _ => panic!("Unexpected event"),
6165         }
6166 }
6167
6168 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6169 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6170 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6171 // once it's freed.
6172 #[test]
6173 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6174         let chanmon_cfgs = create_chanmon_cfgs(3);
6175         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6176         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6177         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6178         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6179         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6180         let logger = test_utils::TestLogger::new();
6181
6182         // First nodes[1] generates an update_fee, setting the channel's
6183         // pending_update_fee.
6184         nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6185         check_added_monitors!(nodes[1], 1);
6186
6187         let events = nodes[1].node.get_and_clear_pending_msg_events();
6188         assert_eq!(events.len(), 1);
6189         let (update_msg, commitment_signed) = match events[0] {
6190                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6191                         (update_fee.as_ref(), commitment_signed)
6192                 },
6193                 _ => panic!("Unexpected event"),
6194         };
6195
6196         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6197
6198         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6199         let channel_reserve = chan_stat.channel_reserve_msat;
6200         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6201
6202         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6203         let feemsat = 239;
6204         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6205         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6206         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6207         let payment_event = {
6208                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6209                 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(), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6210                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6211                 check_added_monitors!(nodes[0], 1);
6212
6213                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6214                 assert_eq!(events.len(), 1);
6215
6216                 SendEvent::from_event(events.remove(0))
6217         };
6218         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6219         check_added_monitors!(nodes[1], 0);
6220         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6221         expect_pending_htlcs_forwardable!(nodes[1]);
6222
6223         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6224         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6225
6226         // Flush the pending fee update.
6227         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6228         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6229         check_added_monitors!(nodes[2], 1);
6230         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6231         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6232         check_added_monitors!(nodes[1], 2);
6233
6234         // A final RAA message is generated to finalize the fee update.
6235         let events = nodes[1].node.get_and_clear_pending_msg_events();
6236         assert_eq!(events.len(), 1);
6237
6238         let raa_msg = match &events[0] {
6239                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6240                         msg.clone()
6241                 },
6242                 _ => panic!("Unexpected event"),
6243         };
6244
6245         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6246         check_added_monitors!(nodes[2], 1);
6247         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6248
6249         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6250         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6251         assert_eq!(process_htlc_forwards_event.len(), 1);
6252         match &process_htlc_forwards_event[0] {
6253                 &Event::PendingHTLCsForwardable { .. } => {},
6254                 _ => panic!("Unexpected event"),
6255         }
6256
6257         // In response, we call ChannelManager's process_pending_htlc_forwards
6258         nodes[1].node.process_pending_htlc_forwards();
6259         check_added_monitors!(nodes[1], 1);
6260
6261         // This causes the HTLC to be failed backwards.
6262         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6263         assert_eq!(fail_event.len(), 1);
6264         let (fail_msg, commitment_signed) = match &fail_event[0] {
6265                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6266                         assert_eq!(updates.update_add_htlcs.len(), 0);
6267                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6268                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6269                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6270                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6271                 },
6272                 _ => panic!("Unexpected event"),
6273         };
6274
6275         // Pass the failure messages back to nodes[0].
6276         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6277         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6278
6279         // Complete the HTLC failure+removal process.
6280         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6281         check_added_monitors!(nodes[0], 1);
6282         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6283         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6284         check_added_monitors!(nodes[1], 2);
6285         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6286         assert_eq!(final_raa_event.len(), 1);
6287         let raa = match &final_raa_event[0] {
6288                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6289                 _ => panic!("Unexpected event"),
6290         };
6291         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6292         let fail_msg_event = nodes[0].node.get_and_clear_pending_msg_events();
6293         assert_eq!(fail_msg_event.len(), 1);
6294         match &fail_msg_event[0] {
6295                 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
6296                 _ => panic!("Unexpected event"),
6297         }
6298         let failure_event = nodes[0].node.get_and_clear_pending_events();
6299         assert_eq!(failure_event.len(), 1);
6300         match &failure_event[0] {
6301                 &Event::PaymentFailed { rejected_by_dest, .. } => {
6302                         assert!(!rejected_by_dest);
6303                 },
6304                 _ => panic!("Unexpected event"),
6305         }
6306         check_added_monitors!(nodes[0], 1);
6307 }
6308
6309 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6310 // 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.
6311 //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.
6312
6313 #[test]
6314 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6315         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6316         let chanmon_cfgs = create_chanmon_cfgs(2);
6317         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6318         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6319         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6320         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6321
6322         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6323         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6324         let logger = test_utils::TestLogger::new();
6325         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6326         route.paths[0][0].fee_msat = 100;
6327
6328         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6329                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6330         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6331         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6332 }
6333
6334 #[test]
6335 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6336         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6337         let chanmon_cfgs = create_chanmon_cfgs(2);
6338         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6339         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6340         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6341         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6342         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6343
6344         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6345         let logger = test_utils::TestLogger::new();
6346         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6347         route.paths[0][0].fee_msat = 0;
6348         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6349                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6350
6351         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6352         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6353 }
6354
6355 #[test]
6356 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6357         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6358         let chanmon_cfgs = create_chanmon_cfgs(2);
6359         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6360         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6361         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6362         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6363
6364         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6365         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6366         let logger = test_utils::TestLogger::new();
6367         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6368         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6369         check_added_monitors!(nodes[0], 1);
6370         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6371         updates.update_add_htlcs[0].amount_msat = 0;
6372
6373         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6374         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6375         check_closed_broadcast!(nodes[1], true).unwrap();
6376         check_added_monitors!(nodes[1], 1);
6377 }
6378
6379 #[test]
6380 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6381         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6382         //It is enforced when constructing a route.
6383         let chanmon_cfgs = create_chanmon_cfgs(2);
6384         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6385         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6386         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6387         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::known(), InitFeatures::known());
6388         let logger = test_utils::TestLogger::new();
6389
6390         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6391
6392         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6393         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(), None, &[], 100000000, 500000001, &logger).unwrap();
6394         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::RouteError { ref err },
6395                 assert_eq!(err, &"Channel CLTV overflowed?"));
6396 }
6397
6398 #[test]
6399 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6400         //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.
6401         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6402         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6403         let chanmon_cfgs = create_chanmon_cfgs(2);
6404         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6405         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6406         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6407         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6408         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6409
6410         let logger = test_utils::TestLogger::new();
6411         for i in 0..max_accepted_htlcs {
6412                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6413                 let payment_event = {
6414                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6415                         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6416                         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6417                         check_added_monitors!(nodes[0], 1);
6418
6419                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6420                         assert_eq!(events.len(), 1);
6421                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6422                                 assert_eq!(htlcs[0].htlc_id, i);
6423                         } else {
6424                                 assert!(false);
6425                         }
6426                         SendEvent::from_event(events.remove(0))
6427                 };
6428                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6429                 check_added_monitors!(nodes[1], 0);
6430                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6431
6432                 expect_pending_htlcs_forwardable!(nodes[1]);
6433                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
6434         }
6435         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6436         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6437         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6438         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6439                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6440
6441         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6442         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6443 }
6444
6445 #[test]
6446 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6447         //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.
6448         let chanmon_cfgs = create_chanmon_cfgs(2);
6449         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6450         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6451         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6452         let channel_value = 100000;
6453         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6454         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6455
6456         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
6457
6458         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6459         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6460         let logger = test_utils::TestLogger::new();
6461         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(), None, &[], max_in_flight+1, TEST_FINAL_CLTV, &logger).unwrap();
6462         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6463                 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)));
6464
6465         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6466         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over the max HTLC value in flight our peer will accept".to_string(), 1);
6467
6468         send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
6469 }
6470
6471 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6472 #[test]
6473 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6474         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6475         let chanmon_cfgs = create_chanmon_cfgs(2);
6476         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6477         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6478         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6479         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6480         let htlc_minimum_msat: u64;
6481         {
6482                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6483                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6484                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6485         }
6486
6487         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6488         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6489         let logger = test_utils::TestLogger::new();
6490         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(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV, &logger).unwrap();
6491         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6492         check_added_monitors!(nodes[0], 1);
6493         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6494         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6495         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6496         assert!(nodes[1].node.list_channels().is_empty());
6497         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6498         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()));
6499         check_added_monitors!(nodes[1], 1);
6500 }
6501
6502 #[test]
6503 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6504         //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
6505         let chanmon_cfgs = create_chanmon_cfgs(2);
6506         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6507         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6508         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6509         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6510         let logger = test_utils::TestLogger::new();
6511
6512         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6513         let channel_reserve = chan_stat.channel_reserve_msat;
6514         let feerate = get_feerate!(nodes[0], chan.2);
6515         // The 2* and +1 are for the fee spike reserve.
6516         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6517
6518         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6519         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6520         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6521         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(), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6522         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6523         check_added_monitors!(nodes[0], 1);
6524         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6525
6526         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6527         // at this time channel-initiatee receivers are not required to enforce that senders
6528         // respect the fee_spike_reserve.
6529         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6530         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6531
6532         assert!(nodes[1].node.list_channels().is_empty());
6533         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6534         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6535         check_added_monitors!(nodes[1], 1);
6536 }
6537
6538 #[test]
6539 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6540         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6541         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6542         let chanmon_cfgs = create_chanmon_cfgs(2);
6543         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6544         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6545         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6546         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6547         let logger = test_utils::TestLogger::new();
6548
6549         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6550         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6551
6552         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6553         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(), None, &[], 3999999, TEST_FINAL_CLTV, &logger).unwrap();
6554
6555         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6556         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6557         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &None, cur_height).unwrap();
6558         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6559
6560         let mut msg = msgs::UpdateAddHTLC {
6561                 channel_id: chan.2,
6562                 htlc_id: 0,
6563                 amount_msat: 1000,
6564                 payment_hash: our_payment_hash,
6565                 cltv_expiry: htlc_cltv,
6566                 onion_routing_packet: onion_packet.clone(),
6567         };
6568
6569         for i in 0..super::channel::OUR_MAX_HTLCS {
6570                 msg.htlc_id = i as u64;
6571                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6572         }
6573         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6574         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6575
6576         assert!(nodes[1].node.list_channels().is_empty());
6577         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6578         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6579         check_added_monitors!(nodes[1], 1);
6580 }
6581
6582 #[test]
6583 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6584         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
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, 1000000, InitFeatures::known(), InitFeatures::known());
6590         let logger = test_utils::TestLogger::new();
6591
6592         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6593         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6594         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(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6595         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6596         check_added_monitors!(nodes[0], 1);
6597         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6598         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6599         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6600
6601         assert!(nodes[1].node.list_channels().is_empty());
6602         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6603         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6604         check_added_monitors!(nodes[1], 1);
6605 }
6606
6607 #[test]
6608 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6609         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6610         let chanmon_cfgs = create_chanmon_cfgs(2);
6611         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6612         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6613         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6614         let logger = test_utils::TestLogger::new();
6615
6616         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6617         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6618         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6619         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(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6620         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6621         check_added_monitors!(nodes[0], 1);
6622         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6623         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6624         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6625
6626         assert!(nodes[1].node.list_channels().is_empty());
6627         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6628         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6629         check_added_monitors!(nodes[1], 1);
6630 }
6631
6632 #[test]
6633 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6634         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6635         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6636         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6637         let chanmon_cfgs = create_chanmon_cfgs(2);
6638         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6639         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6640         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6641         let logger = test_utils::TestLogger::new();
6642
6643         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6644         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6645         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6646         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(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6647         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6648         check_added_monitors!(nodes[0], 1);
6649         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6650         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6651
6652         //Disconnect and Reconnect
6653         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6654         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6655         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6656         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6657         assert_eq!(reestablish_1.len(), 1);
6658         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6659         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6660         assert_eq!(reestablish_2.len(), 1);
6661         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6662         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6663         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6664         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6665
6666         //Resend HTLC
6667         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6668         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6669         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6670         check_added_monitors!(nodes[1], 1);
6671         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6672
6673         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6674
6675         assert!(nodes[1].node.list_channels().is_empty());
6676         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6677         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6678         check_added_monitors!(nodes[1], 1);
6679 }
6680
6681 #[test]
6682 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6683         //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.
6684
6685         let chanmon_cfgs = create_chanmon_cfgs(2);
6686         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6687         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6688         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6689         let logger = test_utils::TestLogger::new();
6690         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6691         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6692         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6693         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(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6694         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6695
6696         check_added_monitors!(nodes[0], 1);
6697         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6698         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6699
6700         let update_msg = msgs::UpdateFulfillHTLC{
6701                 channel_id: chan.2,
6702                 htlc_id: 0,
6703                 payment_preimage: our_payment_preimage,
6704         };
6705
6706         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6707
6708         assert!(nodes[0].node.list_channels().is_empty());
6709         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6710         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()));
6711         check_added_monitors!(nodes[0], 1);
6712 }
6713
6714 #[test]
6715 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6716         //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.
6717
6718         let chanmon_cfgs = create_chanmon_cfgs(2);
6719         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6720         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6721         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6722         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6723         let logger = test_utils::TestLogger::new();
6724
6725         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
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(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6728         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6729         check_added_monitors!(nodes[0], 1);
6730         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6731         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6732
6733         let update_msg = msgs::UpdateFailHTLC{
6734                 channel_id: chan.2,
6735                 htlc_id: 0,
6736                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6737         };
6738
6739         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6740
6741         assert!(nodes[0].node.list_channels().is_empty());
6742         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6743         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()));
6744         check_added_monitors!(nodes[0], 1);
6745 }
6746
6747 #[test]
6748 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6749         //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.
6750
6751         let chanmon_cfgs = create_chanmon_cfgs(2);
6752         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6753         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6754         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6755         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6756         let logger = test_utils::TestLogger::new();
6757
6758         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6759         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6760         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(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6761         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6762         check_added_monitors!(nodes[0], 1);
6763         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6764         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6765
6766         let update_msg = msgs::UpdateFailMalformedHTLC{
6767                 channel_id: chan.2,
6768                 htlc_id: 0,
6769                 sha256_of_onion: [1; 32],
6770                 failure_code: 0x8000,
6771         };
6772
6773         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6774
6775         assert!(nodes[0].node.list_channels().is_empty());
6776         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6777         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()));
6778         check_added_monitors!(nodes[0], 1);
6779 }
6780
6781 #[test]
6782 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6783         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6784
6785         let chanmon_cfgs = create_chanmon_cfgs(2);
6786         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6787         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6788         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6789         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6790
6791         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6792
6793         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6794         check_added_monitors!(nodes[1], 1);
6795
6796         let events = nodes[1].node.get_and_clear_pending_msg_events();
6797         assert_eq!(events.len(), 1);
6798         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6799                 match events[0] {
6800                         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, .. } } => {
6801                                 assert!(update_add_htlcs.is_empty());
6802                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6803                                 assert!(update_fail_htlcs.is_empty());
6804                                 assert!(update_fail_malformed_htlcs.is_empty());
6805                                 assert!(update_fee.is_none());
6806                                 update_fulfill_htlcs[0].clone()
6807                         },
6808                         _ => panic!("Unexpected event"),
6809                 }
6810         };
6811
6812         update_fulfill_msg.htlc_id = 1;
6813
6814         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6815
6816         assert!(nodes[0].node.list_channels().is_empty());
6817         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6818         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6819         check_added_monitors!(nodes[0], 1);
6820 }
6821
6822 #[test]
6823 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6824         //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.
6825
6826         let chanmon_cfgs = create_chanmon_cfgs(2);
6827         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6828         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6829         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6830         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6831
6832         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6833
6834         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6835         check_added_monitors!(nodes[1], 1);
6836
6837         let events = nodes[1].node.get_and_clear_pending_msg_events();
6838         assert_eq!(events.len(), 1);
6839         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6840                 match events[0] {
6841                         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, .. } } => {
6842                                 assert!(update_add_htlcs.is_empty());
6843                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6844                                 assert!(update_fail_htlcs.is_empty());
6845                                 assert!(update_fail_malformed_htlcs.is_empty());
6846                                 assert!(update_fee.is_none());
6847                                 update_fulfill_htlcs[0].clone()
6848                         },
6849                         _ => panic!("Unexpected event"),
6850                 }
6851         };
6852
6853         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6854
6855         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6856
6857         assert!(nodes[0].node.list_channels().is_empty());
6858         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6859         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6860         check_added_monitors!(nodes[0], 1);
6861 }
6862
6863 #[test]
6864 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6865         //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.
6866
6867         let chanmon_cfgs = create_chanmon_cfgs(2);
6868         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6869         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6870         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6871         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6872         let logger = test_utils::TestLogger::new();
6873
6874         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6875         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6876         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(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6877         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6878         check_added_monitors!(nodes[0], 1);
6879
6880         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6881         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6882
6883         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6884         check_added_monitors!(nodes[1], 0);
6885         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6886
6887         let events = nodes[1].node.get_and_clear_pending_msg_events();
6888
6889         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6890                 match events[0] {
6891                         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, .. } } => {
6892                                 assert!(update_add_htlcs.is_empty());
6893                                 assert!(update_fulfill_htlcs.is_empty());
6894                                 assert!(update_fail_htlcs.is_empty());
6895                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6896                                 assert!(update_fee.is_none());
6897                                 update_fail_malformed_htlcs[0].clone()
6898                         },
6899                         _ => panic!("Unexpected event"),
6900                 }
6901         };
6902         update_msg.failure_code &= !0x8000;
6903         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6904
6905         assert!(nodes[0].node.list_channels().is_empty());
6906         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6907         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6908         check_added_monitors!(nodes[0], 1);
6909 }
6910
6911 #[test]
6912 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6913         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6914         //    * 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.
6915
6916         let chanmon_cfgs = create_chanmon_cfgs(3);
6917         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6918         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6919         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6920         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6921         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6922         let logger = test_utils::TestLogger::new();
6923
6924         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6925
6926         //First hop
6927         let mut payment_event = {
6928                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6929                 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(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
6930                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6931                 check_added_monitors!(nodes[0], 1);
6932                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6933                 assert_eq!(events.len(), 1);
6934                 SendEvent::from_event(events.remove(0))
6935         };
6936         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6937         check_added_monitors!(nodes[1], 0);
6938         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6939         expect_pending_htlcs_forwardable!(nodes[1]);
6940         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6941         assert_eq!(events_2.len(), 1);
6942         check_added_monitors!(nodes[1], 1);
6943         payment_event = SendEvent::from_event(events_2.remove(0));
6944         assert_eq!(payment_event.msgs.len(), 1);
6945
6946         //Second Hop
6947         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6948         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6949         check_added_monitors!(nodes[2], 0);
6950         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6951
6952         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6953         assert_eq!(events_3.len(), 1);
6954         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6955                 match events_3[0] {
6956                         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 } } => {
6957                                 assert!(update_add_htlcs.is_empty());
6958                                 assert!(update_fulfill_htlcs.is_empty());
6959                                 assert!(update_fail_htlcs.is_empty());
6960                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6961                                 assert!(update_fee.is_none());
6962                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6963                         },
6964                         _ => panic!("Unexpected event"),
6965                 }
6966         };
6967
6968         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6969
6970         check_added_monitors!(nodes[1], 0);
6971         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6972         expect_pending_htlcs_forwardable!(nodes[1]);
6973         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6974         assert_eq!(events_4.len(), 1);
6975
6976         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6977         match events_4[0] {
6978                 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, .. } } => {
6979                         assert!(update_add_htlcs.is_empty());
6980                         assert!(update_fulfill_htlcs.is_empty());
6981                         assert_eq!(update_fail_htlcs.len(), 1);
6982                         assert!(update_fail_malformed_htlcs.is_empty());
6983                         assert!(update_fee.is_none());
6984                 },
6985                 _ => panic!("Unexpected event"),
6986         };
6987
6988         check_added_monitors!(nodes[1], 1);
6989 }
6990
6991 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6992         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6993         // 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
6994         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6995
6996         let mut chanmon_cfgs = create_chanmon_cfgs(2);
6997         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
6998         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6999         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7000         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7001         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7002
7003         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7004
7005         // We route 2 dust-HTLCs between A and B
7006         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7007         let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7008         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7009
7010         // Cache one local commitment tx as previous
7011         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7012
7013         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7014         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
7015         check_added_monitors!(nodes[1], 0);
7016         expect_pending_htlcs_forwardable!(nodes[1]);
7017         check_added_monitors!(nodes[1], 1);
7018
7019         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7020         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7021         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7022         check_added_monitors!(nodes[0], 1);
7023
7024         // Cache one local commitment tx as lastest
7025         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7026
7027         let events = nodes[0].node.get_and_clear_pending_msg_events();
7028         match events[0] {
7029                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7030                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7031                 },
7032                 _ => panic!("Unexpected event"),
7033         }
7034         match events[1] {
7035                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7036                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7037                 },
7038                 _ => panic!("Unexpected event"),
7039         }
7040
7041         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7042         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7043         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7044
7045         if announce_latest {
7046                 connect_block(&nodes[0], &Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
7047         } else {
7048                 connect_block(&nodes[0], &Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
7049         }
7050
7051         check_closed_broadcast!(nodes[0], false);
7052         check_added_monitors!(nodes[0], 1);
7053
7054         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7055         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 1, true,  header.block_hash());
7056         let events = nodes[0].node.get_and_clear_pending_events();
7057         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7058         assert_eq!(events.len(), 2);
7059         let mut first_failed = false;
7060         for event in events {
7061                 match event {
7062                         Event::PaymentFailed { payment_hash, .. } => {
7063                                 if payment_hash == payment_hash_1 {
7064                                         assert!(!first_failed);
7065                                         first_failed = true;
7066                                 } else {
7067                                         assert_eq!(payment_hash, payment_hash_2);
7068                                 }
7069                         }
7070                         _ => panic!("Unexpected event"),
7071                 }
7072         }
7073 }
7074
7075 #[test]
7076 fn test_failure_delay_dust_htlc_local_commitment() {
7077         do_test_failure_delay_dust_htlc_local_commitment(true);
7078         do_test_failure_delay_dust_htlc_local_commitment(false);
7079 }
7080
7081 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7082         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7083         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7084         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7085         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7086         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7087         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7088
7089         let chanmon_cfgs = create_chanmon_cfgs(3);
7090         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7091         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7092         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7093         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7094
7095         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7096
7097         let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7098         let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7099
7100         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7101         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7102
7103         // We revoked bs_commitment_tx
7104         if revoked {
7105                 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7106                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
7107         }
7108
7109         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7110         let mut timeout_tx = Vec::new();
7111         if local {
7112                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7113                 connect_block(&nodes[0], &Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
7114                 check_closed_broadcast!(nodes[0], false);
7115                 check_added_monitors!(nodes[0], 1);
7116                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7117                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7118                 let parent_hash  = connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 2, true, header.block_hash());
7119                 expect_payment_failed!(nodes[0], dust_hash, true);
7120                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7121                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7122                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7123                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7124                 connect_block(&nodes[0], &Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7125                 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7126                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 8, true, header_3.block_hash());
7127                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7128         } else {
7129                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7130                 connect_block(&nodes[0], &Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
7131                 check_closed_broadcast!(nodes[0], false);
7132                 check_added_monitors!(nodes[0], 1);
7133                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7134                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7135                 let parent_hash  = connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 2, true, header.block_hash());
7136                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7137                 if !revoked {
7138                         expect_payment_failed!(nodes[0], dust_hash, true);
7139                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7140                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7141                         connect_block(&nodes[0], &Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7142                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7143                         let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7144                         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 8, true, header_3.block_hash());
7145                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7146                 } else {
7147                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7148                         // commitment tx
7149                         let events = nodes[0].node.get_and_clear_pending_events();
7150                         assert_eq!(events.len(), 2);
7151                         let first;
7152                         match events[0] {
7153                                 Event::PaymentFailed { payment_hash, .. } => {
7154                                         if payment_hash == dust_hash { first = true; }
7155                                         else { first = false; }
7156                                 },
7157                                 _ => panic!("Unexpected event"),
7158                         }
7159                         match events[1] {
7160                                 Event::PaymentFailed { payment_hash, .. } => {
7161                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7162                                         else { assert_eq!(payment_hash, dust_hash); }
7163                                 },
7164                                 _ => panic!("Unexpected event"),
7165                         }
7166                 }
7167         }
7168 }
7169
7170 #[test]
7171 fn test_sweep_outbound_htlc_failure_update() {
7172         do_test_sweep_outbound_htlc_failure_update(false, true);
7173         do_test_sweep_outbound_htlc_failure_update(false, false);
7174         do_test_sweep_outbound_htlc_failure_update(true, false);
7175 }
7176
7177 #[test]
7178 fn test_upfront_shutdown_script() {
7179         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7180         // enforce it at shutdown message
7181
7182         let mut config = UserConfig::default();
7183         config.channel_options.announced_channel = true;
7184         config.peer_channel_config_limits.force_announced_channel_preference = false;
7185         config.channel_options.commit_upfront_shutdown_pubkey = false;
7186         let user_cfgs = [None, Some(config), None];
7187         let chanmon_cfgs = create_chanmon_cfgs(3);
7188         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7189         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7190         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7191
7192         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7193         let flags = InitFeatures::known();
7194         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7195         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7196         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7197         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7198         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7199         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7200     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()));
7201         check_added_monitors!(nodes[2], 1);
7202
7203         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7204         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7205         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7206         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7207         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7208         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7209         let events = nodes[2].node.get_and_clear_pending_msg_events();
7210         assert_eq!(events.len(), 1);
7211         match events[0] {
7212                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7213                 _ => panic!("Unexpected event"),
7214         }
7215
7216         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7217         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7218         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7219         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7220         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7221         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7222         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
7223         let events = nodes[1].node.get_and_clear_pending_msg_events();
7224         assert_eq!(events.len(), 1);
7225         match events[0] {
7226                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7227                 _ => panic!("Unexpected event"),
7228         }
7229
7230         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7231         // channel smoothly, opt-out is from channel initiator here
7232         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7233         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7234         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7235         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7236         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7237         let events = nodes[0].node.get_and_clear_pending_msg_events();
7238         assert_eq!(events.len(), 1);
7239         match events[0] {
7240                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7241                 _ => panic!("Unexpected event"),
7242         }
7243
7244         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7245         //// channel smoothly
7246         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7247         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7248         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7249         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7250         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7251         let events = nodes[0].node.get_and_clear_pending_msg_events();
7252         assert_eq!(events.len(), 2);
7253         match events[0] {
7254                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7255                 _ => panic!("Unexpected event"),
7256         }
7257         match events[1] {
7258                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7259                 _ => panic!("Unexpected event"),
7260         }
7261 }
7262
7263 #[test]
7264 fn test_user_configurable_csv_delay() {
7265         // We test our channel constructors yield errors when we pass them absurd csv delay
7266
7267         let mut low_our_to_self_config = UserConfig::default();
7268         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7269         let mut high_their_to_self_config = UserConfig::default();
7270         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7271         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7272         let chanmon_cfgs = create_chanmon_cfgs(2);
7273         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7274         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7275         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7276
7277         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7278         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) {
7279                 match error {
7280                         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())); },
7281                         _ => panic!("Unexpected event"),
7282                 }
7283         } else { assert!(false) }
7284
7285         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7286         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7287         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7288         open_channel.to_self_delay = 200;
7289         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) {
7290                 match error {
7291                         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()));  },
7292                         _ => panic!("Unexpected event"),
7293                 }
7294         } else { assert!(false); }
7295
7296         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7297         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7298         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()));
7299         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7300         accept_channel.to_self_delay = 200;
7301         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7302         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7303                 match action {
7304                         &ErrorAction::SendErrorMessage { ref msg } => {
7305                                 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()));
7306                         },
7307                         _ => { assert!(false); }
7308                 }
7309         } else { assert!(false); }
7310
7311         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7312         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7313         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7314         open_channel.to_self_delay = 200;
7315         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) {
7316                 match error {
7317                         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())); },
7318                         _ => panic!("Unexpected event"),
7319                 }
7320         } else { assert!(false); }
7321 }
7322
7323 #[test]
7324 fn test_data_loss_protect() {
7325         // We want to be sure that :
7326         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7327         //   (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7328         // * we close channel in case of detecting other being fallen behind
7329         // * we are able to claim our own outputs thanks to to_remote being static
7330         // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7331         let persister;
7332         let logger;
7333         let fee_estimator;
7334         let tx_broadcaster;
7335         let chain_source;
7336         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7337         // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7338         // during signing due to revoked tx
7339         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7340         let keys_manager = &chanmon_cfgs[0].keys_manager;
7341         let monitor;
7342         let node_state_0;
7343         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7344         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7345         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7346
7347         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7348
7349         // Cache node A state before any channel update
7350         let previous_node_state = nodes[0].node.encode();
7351         let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7352         nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7353
7354         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7355         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7356
7357         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7358         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7359
7360         // Restore node A from previous state
7361         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7362         let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7363         chain_source = test_utils::TestChainSource::new(Network::Testnet);
7364         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
7365         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7366         persister = test_utils::TestPersister::new();
7367         monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7368         node_state_0 = {
7369                 let mut channel_monitors = HashMap::new();
7370                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7371                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &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 {
7372                         keys_manager: keys_manager,
7373                         fee_estimator: &fee_estimator,
7374                         chain_monitor: &monitor,
7375                         logger: &logger,
7376                         tx_broadcaster: &tx_broadcaster,
7377                         default_config: UserConfig::default(),
7378                         channel_monitors,
7379                 }).unwrap().1
7380         };
7381         nodes[0].node = &node_state_0;
7382         assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7383         nodes[0].chain_monitor = &monitor;
7384         nodes[0].chain_source = &chain_source;
7385
7386         check_added_monitors!(nodes[0], 1);
7387
7388         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7389         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7390
7391         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7392
7393         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7394         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7395         check_added_monitors!(nodes[0], 1);
7396
7397         {
7398                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7399                 assert_eq!(node_txn.len(), 0);
7400         }
7401
7402         let mut reestablish_1 = Vec::with_capacity(1);
7403         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7404                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7405                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7406                         reestablish_1.push(msg.clone());
7407                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7408                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7409                         match action {
7410                                 &ErrorAction::SendErrorMessage { ref msg } => {
7411                                         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");
7412                                 },
7413                                 _ => panic!("Unexpected event!"),
7414                         }
7415                 } else {
7416                         panic!("Unexpected event")
7417                 }
7418         }
7419
7420         // Check we close channel detecting A is fallen-behind
7421         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7422         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7423         check_added_monitors!(nodes[1], 1);
7424
7425
7426         // Check A is able to claim to_remote output
7427         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7428         assert_eq!(node_txn.len(), 1);
7429         check_spends!(node_txn[0], chan.3);
7430         assert_eq!(node_txn[0].output.len(), 2);
7431         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
7432         connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[0].clone()]}, 0);
7433         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 0, true, header.block_hash());
7434         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 1000000);
7435         assert_eq!(spend_txn.len(), 1);
7436         check_spends!(spend_txn[0], node_txn[0]);
7437 }
7438
7439 #[test]
7440 fn test_check_htlc_underpaying() {
7441         // Send payment through A -> B but A is maliciously
7442         // sending a probe payment (i.e less than expected value0
7443         // to B, B should refuse payment.
7444
7445         let chanmon_cfgs = create_chanmon_cfgs(2);
7446         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7447         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7448         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7449
7450         // Create some initial channels
7451         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7452
7453         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
7454
7455         // Node 3 is expecting payment of 100_000 but receive 10_000,
7456         // fail htlc like we didn't know the preimage.
7457         nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
7458         nodes[1].node.process_pending_htlc_forwards();
7459
7460         let events = nodes[1].node.get_and_clear_pending_msg_events();
7461         assert_eq!(events.len(), 1);
7462         let (update_fail_htlc, commitment_signed) = match events[0] {
7463                 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 } } => {
7464                         assert!(update_add_htlcs.is_empty());
7465                         assert!(update_fulfill_htlcs.is_empty());
7466                         assert_eq!(update_fail_htlcs.len(), 1);
7467                         assert!(update_fail_malformed_htlcs.is_empty());
7468                         assert!(update_fee.is_none());
7469                         (update_fail_htlcs[0].clone(), commitment_signed)
7470                 },
7471                 _ => panic!("Unexpected event"),
7472         };
7473         check_added_monitors!(nodes[1], 1);
7474
7475         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7476         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7477
7478         // 10_000 msat as u64, followed by a height of 99 as u32
7479         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7480         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(99));
7481         expect_payment_failed!(nodes[0], payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7482         nodes[1].node.get_and_clear_pending_events();
7483 }
7484
7485 #[test]
7486 fn test_announce_disable_channels() {
7487         // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
7488         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7489
7490         let chanmon_cfgs = create_chanmon_cfgs(2);
7491         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7492         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7493         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7494
7495         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7496         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7497         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7498
7499         // Disconnect peers
7500         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7501         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7502
7503         nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
7504         nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
7505         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7506         assert_eq!(msg_events.len(), 3);
7507         for e in msg_events {
7508                 match e {
7509                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7510                                 let short_id = msg.contents.short_channel_id;
7511                                 // Check generated channel_update match list in PendingChannelUpdate
7512                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
7513                                         panic!("Generated ChannelUpdate for wrong chan!");
7514                                 }
7515                         },
7516                         _ => panic!("Unexpected event"),
7517                 }
7518         }
7519         // Reconnect peers
7520         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7521         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7522         assert_eq!(reestablish_1.len(), 3);
7523         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7524         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7525         assert_eq!(reestablish_2.len(), 3);
7526
7527         // Reestablish chan_1
7528         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7529         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7530         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7531         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7532         // Reestablish chan_2
7533         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7534         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7535         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7536         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7537         // Reestablish chan_3
7538         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7539         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7540         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7541         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7542
7543         nodes[0].node.timer_chan_freshness_every_min();
7544         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7545 }
7546
7547 #[test]
7548 fn test_bump_penalty_txn_on_revoked_commitment() {
7549         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7550         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7551
7552         let chanmon_cfgs = create_chanmon_cfgs(2);
7553         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7554         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7555         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7556
7557         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7558         let logger = test_utils::TestLogger::new();
7559
7560
7561         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7562         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7563         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(), None, &Vec::new(), 3000000, 30, &logger).unwrap();
7564         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7565
7566         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7567         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7568         assert_eq!(revoked_txn[0].output.len(), 4);
7569         assert_eq!(revoked_txn[0].input.len(), 1);
7570         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7571         let revoked_txid = revoked_txn[0].txid();
7572
7573         let mut penalty_sum = 0;
7574         for outp in revoked_txn[0].output.iter() {
7575                 if outp.script_pubkey.is_v0_p2wsh() {
7576                         penalty_sum += outp.value;
7577                 }
7578         }
7579
7580         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7581         let header_114 = connect_blocks(&nodes[1], 114, 0, false, Default::default());
7582
7583         // Actually revoke tx by claiming a HTLC
7584         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7585         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7586         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
7587         check_added_monitors!(nodes[1], 1);
7588
7589         // One or more justice tx should have been broadcast, check it
7590         let penalty_1;
7591         let feerate_1;
7592         {
7593                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7594                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7595                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7596                 assert_eq!(node_txn[0].output.len(), 1);
7597                 check_spends!(node_txn[0], revoked_txn[0]);
7598                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7599                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7600                 penalty_1 = node_txn[0].txid();
7601                 node_txn.clear();
7602         };
7603
7604         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7605         let header = connect_blocks(&nodes[1], 3, 115,  true, header.block_hash());
7606         let mut penalty_2 = penalty_1;
7607         let mut feerate_2 = 0;
7608         {
7609                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7610                 assert_eq!(node_txn.len(), 1);
7611                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7612                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7613                         assert_eq!(node_txn[0].output.len(), 1);
7614                         check_spends!(node_txn[0], revoked_txn[0]);
7615                         penalty_2 = node_txn[0].txid();
7616                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7617                         assert_ne!(penalty_2, penalty_1);
7618                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7619                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7620                         // Verify 25% bump heuristic
7621                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7622                         node_txn.clear();
7623                 }
7624         }
7625         assert_ne!(feerate_2, 0);
7626
7627         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7628         connect_blocks(&nodes[1], 3, 118, true, header);
7629         let penalty_3;
7630         let mut feerate_3 = 0;
7631         {
7632                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7633                 assert_eq!(node_txn.len(), 1);
7634                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7635                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7636                         assert_eq!(node_txn[0].output.len(), 1);
7637                         check_spends!(node_txn[0], revoked_txn[0]);
7638                         penalty_3 = node_txn[0].txid();
7639                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7640                         assert_ne!(penalty_3, penalty_2);
7641                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7642                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7643                         // Verify 25% bump heuristic
7644                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7645                         node_txn.clear();
7646                 }
7647         }
7648         assert_ne!(feerate_3, 0);
7649
7650         nodes[1].node.get_and_clear_pending_events();
7651         nodes[1].node.get_and_clear_pending_msg_events();
7652 }
7653
7654 #[test]
7655 fn test_bump_penalty_txn_on_revoked_htlcs() {
7656         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7657         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7658
7659         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7660         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
7661         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7662         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7663         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7664
7665         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7666         // Lock HTLC in both directions
7667         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
7668         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7669
7670         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7671         assert_eq!(revoked_local_txn[0].input.len(), 1);
7672         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7673
7674         // Revoke local commitment tx
7675         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7676
7677         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7678         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7679         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
7680         check_closed_broadcast!(nodes[1], false);
7681         check_added_monitors!(nodes[1], 1);
7682
7683         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7684         assert_eq!(revoked_htlc_txn.len(), 4);
7685         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7686                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7687                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7688                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7689                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7690                 assert_eq!(revoked_htlc_txn[1].output.len(), 1);
7691                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7692         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7693                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7694                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7695                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7696                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7697                 assert_eq!(revoked_htlc_txn[0].output.len(), 1);
7698                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7699         }
7700
7701         // Broadcast set of revoked txn on A
7702         let header_128 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7703         connect_block(&nodes[0], &Block { header: header_128, txdata: vec![revoked_local_txn[0].clone()] }, 128);
7704         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7705         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7706         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] }, 129);
7707         let first;
7708         let feerate_1;
7709         let penalty_txn;
7710         {
7711                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7712                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7713                 // Verify claim tx are spending revoked HTLC txn
7714
7715                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
7716                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
7717                 // which are included in the same block (they are broadcasted because we scan the
7718                 // transactions linearly and generate claims as we go, they likely should be removed in the
7719                 // future).
7720                 assert_eq!(node_txn[0].input.len(), 1);
7721                 check_spends!(node_txn[0], revoked_local_txn[0]);
7722                 assert_eq!(node_txn[1].input.len(), 1);
7723                 check_spends!(node_txn[1], revoked_local_txn[0]);
7724                 assert_eq!(node_txn[2].input.len(), 1);
7725                 check_spends!(node_txn[2], revoked_local_txn[0]);
7726
7727                 // Each of the three justice transactions claim a separate (single) output of the three
7728                 // available, which we check here:
7729                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
7730                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
7731                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
7732
7733                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7734                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7735
7736                 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
7737                 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
7738                 // a remote commitment tx has already been confirmed).
7739                 check_spends!(node_txn[3], chan.3);
7740
7741                 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
7742                 // output, checked above).
7743                 assert_eq!(node_txn[4].input.len(), 2);
7744                 assert_eq!(node_txn[4].output.len(), 1);
7745                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7746
7747                 first = node_txn[4].txid();
7748                 // Store both feerates for later comparison
7749                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
7750                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7751                 penalty_txn = vec![node_txn[2].clone()];
7752                 node_txn.clear();
7753         }
7754
7755         // Connect one more block to see if bumped penalty are issued for HTLC txn
7756         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7757         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn }, 130);
7758         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7759         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() }, 131);
7760         {
7761                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7762                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7763
7764                 check_spends!(node_txn[0], revoked_local_txn[0]);
7765                 check_spends!(node_txn[1], revoked_local_txn[0]);
7766                 // Note that these are both bogus - they spend outputs already claimed in block 129:
7767                 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output  {
7768                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7769                 } else {
7770                         assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7771                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7772                 }
7773
7774                 node_txn.clear();
7775         };
7776
7777         // Few more blocks to confirm penalty txn
7778         let header_135 = connect_blocks(&nodes[0], 4, 131, true, header_131.block_hash());
7779         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7780         let header_144 = connect_blocks(&nodes[0], 9, 135, true, header_135);
7781         let node_txn = {
7782                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7783                 assert_eq!(node_txn.len(), 1);
7784
7785                 assert_eq!(node_txn[0].input.len(), 2);
7786                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7787                 // Verify bumped tx is different and 25% bump heuristic
7788                 assert_ne!(first, node_txn[0].txid());
7789                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7790                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7791                 assert!(feerate_2 * 100 > feerate_1 * 125);
7792                 let txn = vec![node_txn[0].clone()];
7793                 node_txn.clear();
7794                 txn
7795         };
7796         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7797         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7798         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn }, 145);
7799         connect_blocks(&nodes[0], 20, 145, true, header_145.block_hash());
7800         {
7801                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7802                 // We verify than no new transaction has been broadcast because previously
7803                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7804                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7805                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7806                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7807                 // up bumped justice generation.
7808                 assert_eq!(node_txn.len(), 0);
7809                 node_txn.clear();
7810         }
7811         check_closed_broadcast!(nodes[0], false);
7812         check_added_monitors!(nodes[0], 1);
7813 }
7814
7815 #[test]
7816 fn test_bump_penalty_txn_on_remote_commitment() {
7817         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7818         // we're able to claim outputs on remote commitment transaction before timelocks expiration
7819
7820         // Create 2 HTLCs
7821         // Provide preimage for one
7822         // Check aggregation
7823
7824         let chanmon_cfgs = create_chanmon_cfgs(2);
7825         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7826         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7827         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7828
7829         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7830         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7831         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7832
7833         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7834         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7835         assert_eq!(remote_txn[0].output.len(), 4);
7836         assert_eq!(remote_txn[0].input.len(), 1);
7837         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7838
7839         // Claim a HTLC without revocation (provide B monitor with preimage)
7840         nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
7841         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7842         connect_block(&nodes[1], &Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
7843         check_added_monitors!(nodes[1], 2);
7844
7845         // One or more claim tx should have been broadcast, check it
7846         let timeout;
7847         let preimage;
7848         let feerate_timeout;
7849         let feerate_preimage;
7850         {
7851                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7852                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
7853                 assert_eq!(node_txn[0].input.len(), 1);
7854                 assert_eq!(node_txn[1].input.len(), 1);
7855                 check_spends!(node_txn[0], remote_txn[0]);
7856                 check_spends!(node_txn[1], remote_txn[0]);
7857                 check_spends!(node_txn[2], chan.3);
7858                 check_spends!(node_txn[3], node_txn[2]);
7859                 check_spends!(node_txn[4], node_txn[2]);
7860                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7861                         timeout = node_txn[0].txid();
7862                         let index = node_txn[0].input[0].previous_output.vout;
7863                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7864                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
7865
7866                         preimage = node_txn[1].txid();
7867                         let index = node_txn[1].input[0].previous_output.vout;
7868                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7869                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
7870                 } else {
7871                         timeout = node_txn[1].txid();
7872                         let index = node_txn[1].input[0].previous_output.vout;
7873                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7874                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
7875
7876                         preimage = node_txn[0].txid();
7877                         let index = node_txn[0].input[0].previous_output.vout;
7878                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7879                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
7880                 }
7881                 node_txn.clear();
7882         };
7883         assert_ne!(feerate_timeout, 0);
7884         assert_ne!(feerate_preimage, 0);
7885
7886         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7887         connect_blocks(&nodes[1], 15, 1,  true, header.block_hash());
7888         {
7889                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7890                 assert_eq!(node_txn.len(), 2);
7891                 assert_eq!(node_txn[0].input.len(), 1);
7892                 assert_eq!(node_txn[1].input.len(), 1);
7893                 check_spends!(node_txn[0], remote_txn[0]);
7894                 check_spends!(node_txn[1], remote_txn[0]);
7895                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7896                         let index = node_txn[0].input[0].previous_output.vout;
7897                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7898                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7899                         assert!(new_feerate * 100 > feerate_timeout * 125);
7900                         assert_ne!(timeout, node_txn[0].txid());
7901
7902                         let index = node_txn[1].input[0].previous_output.vout;
7903                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7904                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7905                         assert!(new_feerate * 100 > feerate_preimage * 125);
7906                         assert_ne!(preimage, node_txn[1].txid());
7907                 } else {
7908                         let index = node_txn[1].input[0].previous_output.vout;
7909                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7910                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7911                         assert!(new_feerate * 100 > feerate_timeout * 125);
7912                         assert_ne!(timeout, node_txn[1].txid());
7913
7914                         let index = node_txn[0].input[0].previous_output.vout;
7915                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7916                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7917                         assert!(new_feerate * 100 > feerate_preimage * 125);
7918                         assert_ne!(preimage, node_txn[0].txid());
7919                 }
7920                 node_txn.clear();
7921         }
7922
7923         nodes[1].node.get_and_clear_pending_events();
7924         nodes[1].node.get_and_clear_pending_msg_events();
7925 }
7926
7927 #[test]
7928 fn test_set_outpoints_partial_claiming() {
7929         // - remote party claim tx, new bump tx
7930         // - disconnect remote claiming tx, new bump
7931         // - disconnect tx, see no tx anymore
7932         let chanmon_cfgs = create_chanmon_cfgs(2);
7933         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7934         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7935         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7936
7937         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7938         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7939         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7940
7941         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
7942         let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
7943         assert_eq!(remote_txn.len(), 3);
7944         assert_eq!(remote_txn[0].output.len(), 4);
7945         assert_eq!(remote_txn[0].input.len(), 1);
7946         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7947         check_spends!(remote_txn[1], remote_txn[0]);
7948         check_spends!(remote_txn[2], remote_txn[0]);
7949
7950         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
7951         let prev_header_100 = connect_blocks(&nodes[1], 100, 0, false, Default::default());
7952         // Provide node A with both preimage
7953         nodes[0].node.claim_funds(payment_preimage_1, &None, 3_000_000);
7954         nodes[0].node.claim_funds(payment_preimage_2, &None, 3_000_000);
7955         check_added_monitors!(nodes[0], 2);
7956         nodes[0].node.get_and_clear_pending_events();
7957         nodes[0].node.get_and_clear_pending_msg_events();
7958
7959         // Connect blocks on node A commitment transaction
7960         let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7961         connect_block(&nodes[0], &Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
7962         check_closed_broadcast!(nodes[0], false);
7963         check_added_monitors!(nodes[0], 1);
7964         // Verify node A broadcast tx claiming both HTLCs
7965         {
7966                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7967                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
7968                 assert_eq!(node_txn.len(), 4);
7969                 check_spends!(node_txn[0], remote_txn[0]);
7970                 check_spends!(node_txn[1], chan.3);
7971                 check_spends!(node_txn[2], node_txn[1]);
7972                 check_spends!(node_txn[3], node_txn[1]);
7973                 assert_eq!(node_txn[0].input.len(), 2);
7974                 node_txn.clear();
7975         }
7976
7977         // Connect blocks on node B
7978         connect_blocks(&nodes[1], 135, 0, false, Default::default());
7979         check_closed_broadcast!(nodes[1], false);
7980         check_added_monitors!(nodes[1], 1);
7981         // Verify node B broadcast 2 HTLC-timeout txn
7982         let partial_claim_tx = {
7983                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7984                 assert_eq!(node_txn.len(), 3);
7985                 check_spends!(node_txn[1], node_txn[0]);
7986                 check_spends!(node_txn[2], node_txn[0]);
7987                 assert_eq!(node_txn[1].input.len(), 1);
7988                 assert_eq!(node_txn[2].input.len(), 1);
7989                 node_txn[1].clone()
7990         };
7991
7992         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
7993         let header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7994         connect_block(&nodes[0], &Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
7995         {
7996                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7997                 assert_eq!(node_txn.len(), 1);
7998                 check_spends!(node_txn[0], remote_txn[0]);
7999                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
8000                 node_txn.clear();
8001         }
8002         nodes[0].node.get_and_clear_pending_msg_events();
8003
8004         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
8005         disconnect_block(&nodes[0], &header, 102);
8006         {
8007                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8008                 assert_eq!(node_txn.len(), 1);
8009                 check_spends!(node_txn[0], remote_txn[0]);
8010                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
8011                 node_txn.clear();
8012         }
8013
8014         //// Disconnect one more block and then reconnect multiple no transaction should be generated
8015         disconnect_block(&nodes[0], &header, 101);
8016         connect_blocks(&nodes[1], 15, 101, false, prev_header_100);
8017         {
8018                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8019                 assert_eq!(node_txn.len(), 0);
8020                 node_txn.clear();
8021         }
8022 }
8023
8024 #[test]
8025 fn test_counterparty_raa_skip_no_crash() {
8026         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8027         // commitment transaction, we would have happily carried on and provided them the next
8028         // commitment transaction based on one RAA forward. This would probably eventually have led to
8029         // channel closure, but it would not have resulted in funds loss. Still, our
8030         // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
8031         // check simply that the channel is closed in response to such an RAA, but don't check whether
8032         // we decide to punish our counterparty for revoking their funds (as we don't currently
8033         // implement that).
8034         let chanmon_cfgs = create_chanmon_cfgs(2);
8035         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8036         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8037         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8038         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8039
8040         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8041         let keys = &guard.by_id.get_mut(&channel_id).unwrap().holder_keys;
8042         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8043         let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8044         // Must revoke without gaps
8045         keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8046         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8047                 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8048
8049         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8050                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8051         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8052         check_added_monitors!(nodes[1], 1);
8053 }
8054
8055 #[test]
8056 fn test_bump_txn_sanitize_tracking_maps() {
8057         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8058         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8059
8060         let chanmon_cfgs = create_chanmon_cfgs(2);
8061         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8062         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8063         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8064
8065         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8066         // Lock HTLC in both directions
8067         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8068         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8069
8070         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8071         assert_eq!(revoked_local_txn[0].input.len(), 1);
8072         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8073
8074         // Revoke local commitment tx
8075         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
8076
8077         // Broadcast set of revoked txn on A
8078         let header_128 = connect_blocks(&nodes[0], 128, 0,  false, Default::default());
8079         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8080
8081         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8082         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
8083         check_closed_broadcast!(nodes[0], false);
8084         check_added_monitors!(nodes[0], 1);
8085         let penalty_txn = {
8086                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8087                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8088                 check_spends!(node_txn[0], revoked_local_txn[0]);
8089                 check_spends!(node_txn[1], revoked_local_txn[0]);
8090                 check_spends!(node_txn[2], revoked_local_txn[0]);
8091                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8092                 node_txn.clear();
8093                 penalty_txn
8094         };
8095         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8096         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn }, 130);
8097         connect_blocks(&nodes[0], 5, 130,  false, header_130.block_hash());
8098         {
8099                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap();
8100                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8101                         assert!(monitor.onchain_tx_handler.pending_claim_requests.is_empty());
8102                         assert!(monitor.onchain_tx_handler.claimable_outpoints.is_empty());
8103                 }
8104         }
8105 }
8106
8107 #[test]
8108 fn test_override_channel_config() {
8109         let chanmon_cfgs = create_chanmon_cfgs(2);
8110         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8111         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8112         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8113
8114         // Node0 initiates a channel to node1 using the override config.
8115         let mut override_config = UserConfig::default();
8116         override_config.own_channel_config.our_to_self_delay = 200;
8117
8118         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8119
8120         // Assert the channel created by node0 is using the override config.
8121         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8122         assert_eq!(res.channel_flags, 0);
8123         assert_eq!(res.to_self_delay, 200);
8124 }
8125
8126 #[test]
8127 fn test_override_0msat_htlc_minimum() {
8128         let mut zero_config = UserConfig::default();
8129         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8130         let chanmon_cfgs = create_chanmon_cfgs(2);
8131         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8132         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8133         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8134
8135         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8136         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8137         assert_eq!(res.htlc_minimum_msat, 1);
8138
8139         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8140         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8141         assert_eq!(res.htlc_minimum_msat, 1);
8142 }
8143
8144 #[test]
8145 fn test_simple_payment_secret() {
8146         // Simple test of sending a payment with a payment_secret present. This does not use any AMP
8147         // features, however.
8148         let chanmon_cfgs = create_chanmon_cfgs(3);
8149         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8150         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8151         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8152
8153         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8154         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
8155         let logger = test_utils::TestLogger::new();
8156
8157         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8158         let payment_secret = PaymentSecret([0xdb; 32]);
8159         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8160         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8161         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2]]], 100000, payment_hash, Some(payment_secret.clone()));
8162         // Claiming with all the correct values but the wrong secret should result in nothing...
8163         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &None, 100_000), false);
8164         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 100_000), false);
8165         // ...but with the right secret we should be able to claim all the way back
8166         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage, Some(payment_secret.clone()), 100_000);
8167 }
8168
8169 #[test]
8170 fn test_simple_mpp() {
8171         // Simple test of sending a multi-path payment.
8172         let chanmon_cfgs = create_chanmon_cfgs(4);
8173         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8174         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8175         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8176
8177         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8178         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8179         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8180         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8181         let logger = test_utils::TestLogger::new();
8182
8183         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8184         let payment_secret = PaymentSecret([0xdb; 32]);
8185         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8186         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8187         let path = route.paths[0].clone();
8188         route.paths.push(path);
8189         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8190         route.paths[0][0].short_channel_id = chan_1_id;
8191         route.paths[0][1].short_channel_id = chan_3_id;
8192         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8193         route.paths[1][0].short_channel_id = chan_2_id;
8194         route.paths[1][1].short_channel_id = chan_4_id;
8195         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, Some(payment_secret.clone()));
8196         // Claiming with all the correct values but the wrong secret should result in nothing...
8197         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &None, 200_000), false);
8198         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 200_000), false);
8199         // ...but with the right secret we should be able to claim all the way back
8200         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, Some(payment_secret), 200_000);
8201 }
8202
8203 #[test]
8204 fn test_update_err_monitor_lockdown() {
8205         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8206         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8207         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8208         //
8209         // This scenario may happen in a watchtower setup, where watchtower process a block height
8210         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8211         // commitment at same time.
8212
8213         let chanmon_cfgs = create_chanmon_cfgs(2);
8214         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8215         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8216         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8217
8218         // Create some initial channel
8219         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8220         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8221
8222         // Rebalance the network to generate htlc in the two directions
8223         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8224
8225         // Route a HTLC from node 0 to node 1 (but don't settle)
8226         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8227
8228         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8229         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8230         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8231         let persister = test_utils::TestPersister::new();
8232         let watchtower = {
8233                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap();
8234                 let monitor = monitors.get(&outpoint).unwrap();
8235                 let mut w = test_utils::TestVecWriter(Vec::new());
8236                 monitor.write(&mut w).unwrap();
8237                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
8238                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8239                 assert!(new_monitor == *monitor);
8240                 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);
8241                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8242                 watchtower
8243         };
8244         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8245         watchtower.chain_monitor.block_connected(&header, &[], 200);
8246
8247         // Try to update ChannelMonitor
8248         assert!(nodes[1].node.claim_funds(preimage, &None, 9_000_000));
8249         check_added_monitors!(nodes[1], 1);
8250         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8251         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8252         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8253         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8254                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8255                         if let Err(_) =  watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8256                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8257                 } else { assert!(false); }
8258         } else { assert!(false); };
8259         // Our local monitor is in-sync and hasn't processed yet timeout
8260         check_added_monitors!(nodes[0], 1);
8261         let events = nodes[0].node.get_and_clear_pending_events();
8262         assert_eq!(events.len(), 1);
8263 }
8264
8265 #[test]
8266 fn test_concurrent_monitor_claim() {
8267         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8268         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8269         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8270         // state N+1 confirms. Alice claims output from state N+1.
8271
8272         let chanmon_cfgs = create_chanmon_cfgs(2);
8273         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8274         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8275         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8276
8277         // Create some initial channel
8278         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8279         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8280
8281         // Rebalance the network to generate htlc in the two directions
8282         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8283
8284         // Route a HTLC from node 0 to node 1 (but don't settle)
8285         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8286
8287         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8288         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8289         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8290         let persister = test_utils::TestPersister::new();
8291         let watchtower_alice = {
8292                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap();
8293                 let monitor = monitors.get(&outpoint).unwrap();
8294                 let mut w = test_utils::TestVecWriter(Vec::new());
8295                 monitor.write(&mut w).unwrap();
8296                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
8297                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8298                 assert!(new_monitor == *monitor);
8299                 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);
8300                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8301                 watchtower
8302         };
8303         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8304         watchtower_alice.chain_monitor.block_connected(&header, &vec![], 135);
8305
8306         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8307         {
8308                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8309                 assert_eq!(txn.len(), 2);
8310                 txn.clear();
8311         }
8312
8313         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8314         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8315         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8316         let persister = test_utils::TestPersister::new();
8317         let watchtower_bob = {
8318                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap();
8319                 let monitor = monitors.get(&outpoint).unwrap();
8320                 let mut w = test_utils::TestVecWriter(Vec::new());
8321                 monitor.write(&mut w).unwrap();
8322                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
8323                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8324                 assert!(new_monitor == *monitor);
8325                 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);
8326                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8327                 watchtower
8328         };
8329         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8330         watchtower_bob.chain_monitor.block_connected(&header, &vec![], 134);
8331
8332         // Route another payment to generate another update with still previous HTLC pending
8333         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
8334         {
8335                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8336                 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(), None, &Vec::new(), 3000000 , TEST_FINAL_CLTV, &logger).unwrap();
8337                 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
8338         }
8339         check_added_monitors!(nodes[1], 1);
8340
8341         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8342         assert_eq!(updates.update_add_htlcs.len(), 1);
8343         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8344         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8345                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8346                         // Watchtower Alice should already have seen the block and reject the update
8347                         if let Err(_) =  watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8348                         if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8349                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8350                 } else { assert!(false); }
8351         } else { assert!(false); };
8352         // Our local monitor is in-sync and hasn't processed yet timeout
8353         check_added_monitors!(nodes[0], 1);
8354
8355         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8356         watchtower_bob.chain_monitor.block_connected(&header, &vec![], 135);
8357
8358         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8359         let bob_state_y;
8360         {
8361                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8362                 assert_eq!(txn.len(), 2);
8363                 bob_state_y = txn[0].clone();
8364                 txn.clear();
8365         };
8366
8367         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8368         watchtower_alice.chain_monitor.block_connected(&header, &vec![(0, &bob_state_y)], 136);
8369         {
8370                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8371                 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8372                 // the onchain detection of the HTLC output
8373                 assert_eq!(htlc_txn.len(), 2);
8374                 check_spends!(htlc_txn[0], bob_state_y);
8375                 check_spends!(htlc_txn[1], bob_state_y);
8376         }
8377 }
8378
8379 #[test]
8380 fn test_pre_lockin_no_chan_closed_update() {
8381         // Test that if a peer closes a channel in response to a funding_created message we don't
8382         // generate a channel update (as the channel cannot appear on chain without a funding_signed
8383         // message).
8384         //
8385         // Doing so would imply a channel monitor update before the initial channel monitor
8386         // registration, violating our API guarantees.
8387         //
8388         // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8389         // then opening a second channel with the same funding output as the first (which is not
8390         // rejected because the first channel does not exist in the ChannelManager) and closing it
8391         // before receiving funding_signed.
8392         let chanmon_cfgs = create_chanmon_cfgs(2);
8393         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8394         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8395         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8396
8397         // Create an initial channel
8398         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8399         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8400         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8401         let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8402         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8403
8404         // Move the first channel through the funding flow...
8405         let (temporary_channel_id, _tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
8406
8407         nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
8408         check_added_monitors!(nodes[0], 0);
8409
8410         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8411         let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8412         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8413         assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8414 }
8415
8416 #[test]
8417 fn test_htlc_no_detection() {
8418         // This test is a mutation to underscore the detection logic bug we had
8419         // before #653. HTLC value routed is above the remaining balance, thus
8420         // inverting HTLC and `to_remote` output. HTLC will come second and
8421         // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8422         // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8423         // outputs order detection for correct spending children filtring.
8424
8425         let chanmon_cfgs = create_chanmon_cfgs(2);
8426         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8427         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8428         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8429
8430         // Create some initial channels
8431         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8432
8433         send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000, 1_000_000);
8434         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8435         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8436         assert_eq!(local_txn[0].input.len(), 1);
8437         assert_eq!(local_txn[0].output.len(), 3);
8438         check_spends!(local_txn[0], chan_1.3);
8439
8440         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8441         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8442         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] }, 200);
8443         // We deliberately connect the local tx twice as this should provoke a failure calling
8444         // this test before #653 fix.
8445         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] }, 200);
8446         check_closed_broadcast!(nodes[0], false);
8447         check_added_monitors!(nodes[0], 1);
8448
8449         let htlc_timeout = {
8450                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8451                 assert_eq!(node_txn[0].input.len(), 1);
8452                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8453                 check_spends!(node_txn[0], local_txn[0]);
8454                 node_txn[0].clone()
8455         };
8456
8457         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8458         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
8459         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 201, true, header_201.block_hash());
8460         expect_payment_failed!(nodes[0], our_payment_hash, true);
8461 }
8462
8463 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8464         // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8465         // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8466         // Carol, Alice would be the upstream node, and Carol the downstream.)
8467         //
8468         // Steps of the test:
8469         // 1) Alice sends a HTLC to Carol through Bob.
8470         // 2) Carol doesn't settle the HTLC.
8471         // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8472         // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8473         // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8474         //    but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8475         // 5) Carol release the preimage to Bob off-chain.
8476         // 6) Bob claims the offered output on the broadcasted commitment.
8477         let chanmon_cfgs = create_chanmon_cfgs(3);
8478         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8479         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8480         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8481
8482         // Create some initial channels
8483         let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8484         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8485
8486         // Steps (1) and (2):
8487         // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8488         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8489
8490         // Check that Alice's commitment transaction now contains an output for this HTLC.
8491         let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8492         check_spends!(alice_txn[0], chan_ab.3);
8493         assert_eq!(alice_txn[0].output.len(), 2);
8494         check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8495         assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8496         assert_eq!(alice_txn.len(), 2);
8497
8498         // Steps (3) and (4):
8499         // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8500         // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8501         let mut force_closing_node = 0; // Alice force-closes
8502         if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8503         nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8504         check_closed_broadcast!(nodes[force_closing_node], false);
8505         check_added_monitors!(nodes[force_closing_node], 1);
8506         if go_onchain_before_fulfill {
8507                 let txn_to_broadcast = match broadcast_alice {
8508                         true => alice_txn.clone(),
8509                         false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8510                 };
8511                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8512                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]}, 1);
8513                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8514                 if broadcast_alice {
8515                         check_closed_broadcast!(nodes[1], false);
8516                         check_added_monitors!(nodes[1], 1);
8517                 }
8518                 assert_eq!(bob_txn.len(), 1);
8519                 check_spends!(bob_txn[0], chan_ab.3);
8520         }
8521
8522         // Step (5):
8523         // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8524         // process of removing the HTLC from their commitment transactions.
8525         assert!(nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000));
8526         check_added_monitors!(nodes[2], 1);
8527         let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8528         assert!(carol_updates.update_add_htlcs.is_empty());
8529         assert!(carol_updates.update_fail_htlcs.is_empty());
8530         assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8531         assert!(carol_updates.update_fee.is_none());
8532         assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8533
8534         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8535         // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8536         if !go_onchain_before_fulfill && broadcast_alice {
8537                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8538                 assert_eq!(events.len(), 1);
8539                 match events[0] {
8540                         MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8541                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8542                         },
8543                         _ => panic!("Unexpected event"),
8544                 };
8545         }
8546         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8547         // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8548         // Carol<->Bob's updated commitment transaction info.
8549         check_added_monitors!(nodes[1], 2);
8550
8551         let events = nodes[1].node.get_and_clear_pending_msg_events();
8552         assert_eq!(events.len(), 2);
8553         let bob_revocation = match events[0] {
8554                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8555                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8556                         (*msg).clone()
8557                 },
8558                 _ => panic!("Unexpected event"),
8559         };
8560         let bob_updates = match events[1] {
8561                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8562                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8563                         (*updates).clone()
8564                 },
8565                 _ => panic!("Unexpected event"),
8566         };
8567
8568         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8569         check_added_monitors!(nodes[2], 1);
8570         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8571         check_added_monitors!(nodes[2], 1);
8572
8573         let events = nodes[2].node.get_and_clear_pending_msg_events();
8574         assert_eq!(events.len(), 1);
8575         let carol_revocation = match events[0] {
8576                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8577                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8578                         (*msg).clone()
8579                 },
8580                 _ => panic!("Unexpected event"),
8581         };
8582         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8583         check_added_monitors!(nodes[1], 1);
8584
8585         // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8586         // here's where we put said channel's commitment tx on-chain.
8587         let mut txn_to_broadcast = alice_txn.clone();
8588         if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8589         if !go_onchain_before_fulfill {
8590                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8591                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]}, 1);
8592                 // If Bob was the one to force-close, he will have already passed these checks earlier.
8593                 if broadcast_alice {
8594                         check_closed_broadcast!(nodes[1], false);
8595                         check_added_monitors!(nodes[1], 1);
8596                 }
8597                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8598                 if broadcast_alice {
8599                         // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8600                         // new block being connected. The ChannelManager being notified triggers a monitor update,
8601                         // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8602                         // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8603                         // broadcasted.
8604                         assert_eq!(bob_txn.len(), 3);
8605                         check_spends!(bob_txn[1], chan_ab.3);
8606                 } else {
8607                         assert_eq!(bob_txn.len(), 2);
8608                         check_spends!(bob_txn[0], chan_ab.3);
8609                 }
8610         }
8611
8612         // Step (6):
8613         // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8614         // broadcasted commitment transaction.
8615         {
8616                 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8617                 if go_onchain_before_fulfill {
8618                         // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
8619                         assert_eq!(bob_txn.len(), 2);
8620                 }
8621                 let script_weight = match broadcast_alice {
8622                         true => OFFERED_HTLC_SCRIPT_WEIGHT,
8623                         false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8624                 };
8625                 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
8626                 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
8627                 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
8628                 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
8629                 if broadcast_alice && !go_onchain_before_fulfill {
8630                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
8631                         assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
8632                 } else {
8633                         check_spends!(bob_txn[1], txn_to_broadcast[0]);
8634                         assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
8635                 }
8636         }
8637 }
8638
8639 #[test]
8640 fn test_onchain_htlc_settlement_after_close() {
8641         do_test_onchain_htlc_settlement_after_close(true, true);
8642         do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
8643         do_test_onchain_htlc_settlement_after_close(true, false);
8644         do_test_onchain_htlc_settlement_after_close(false, false);
8645 }
8646
8647 #[test]
8648 fn test_duplicate_chan_id() {
8649         // Test that if a given peer tries to open a channel with the same channel_id as one that is
8650         // already open we reject it and keep the old channel.
8651         //
8652         // Previously, full_stack_target managed to figure out that if you tried to open two channels
8653         // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
8654         // the existing channel when we detect the duplicate new channel, screwing up our monitor
8655         // updating logic for the existing channel.
8656         let chanmon_cfgs = create_chanmon_cfgs(2);
8657         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8658         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8659         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8660
8661         // Create an initial channel
8662         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8663         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8664         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8665         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()));
8666
8667         // Try to create a second channel with the same temporary_channel_id as the first and check
8668         // that it is rejected.
8669         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8670         {
8671                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8672                 assert_eq!(events.len(), 1);
8673                 match events[0] {
8674                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8675                                 // Technically, at this point, nodes[1] would be justified in thinking both the
8676                                 // first (valid) and second (invalid) channels are closed, given they both have
8677                                 // the same non-temporary channel_id. However, currently we do not, so we just
8678                                 // move forward with it.
8679                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8680                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8681                         },
8682                         _ => panic!("Unexpected event"),
8683                 }
8684         }
8685
8686         // Move the first channel through the funding flow...
8687         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
8688
8689         nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
8690         check_added_monitors!(nodes[0], 0);
8691
8692         let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8693         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8694         {
8695                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
8696                 assert_eq!(added_monitors.len(), 1);
8697                 assert_eq!(added_monitors[0].0, funding_output);
8698                 added_monitors.clear();
8699         }
8700         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8701
8702         let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
8703         let channel_id = funding_outpoint.to_channel_id();
8704
8705         // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
8706         // temporary one).
8707
8708         // First try to open a second channel with a temporary channel id equal to the txid-based one.
8709         // Technically this is allowed by the spec, but we don't support it and there's little reason
8710         // to. Still, it shouldn't cause any other issues.
8711         open_chan_msg.temporary_channel_id = channel_id;
8712         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8713         {
8714                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8715                 assert_eq!(events.len(), 1);
8716                 match events[0] {
8717                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8718                                 // Technically, at this point, nodes[1] would be justified in thinking both
8719                                 // channels are closed, but currently we do not, so we just move forward with it.
8720                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8721                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8722                         },
8723                         _ => panic!("Unexpected event"),
8724                 }
8725         }
8726
8727         // Now try to create a second channel which has a duplicate funding output.
8728         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8729         let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8730         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
8731         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()));
8732         create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
8733
8734         let funding_created = {
8735                 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
8736                 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
8737                 let logger = test_utils::TestLogger::new();
8738                 as_chan.get_outbound_funding_created(funding_outpoint, &&logger).unwrap()
8739         };
8740         check_added_monitors!(nodes[0], 0);
8741         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
8742         // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
8743         // still needs to be cleared here.
8744         check_added_monitors!(nodes[1], 1);
8745
8746         // ...still, nodes[1] will reject the duplicate channel.
8747         {
8748                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8749                 assert_eq!(events.len(), 1);
8750                 match events[0] {
8751                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8752                                 // Technically, at this point, nodes[1] would be justified in thinking both
8753                                 // channels are closed, but currently we do not, so we just move forward with it.
8754                                 assert_eq!(msg.channel_id, channel_id);
8755                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8756                         },
8757                         _ => panic!("Unexpected event"),
8758                 }
8759         }
8760
8761         // finally, finish creating the original channel and send a payment over it to make sure
8762         // everything is functional.
8763         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
8764         {
8765                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
8766                 assert_eq!(added_monitors.len(), 1);
8767                 assert_eq!(added_monitors[0].0, funding_output);
8768                 added_monitors.clear();
8769         }
8770
8771         let events_4 = nodes[0].node.get_and_clear_pending_events();
8772         assert_eq!(events_4.len(), 1);
8773         match events_4[0] {
8774                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
8775                         assert_eq!(user_channel_id, 42);
8776                         assert_eq!(*funding_txo, funding_output);
8777                 },
8778                 _ => panic!("Unexpected event"),
8779         };
8780
8781         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8782         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
8783         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
8784         send_payment(&nodes[0], &[&nodes[1]], 8000000, 8_000_000);
8785 }
8786
8787 #[test]
8788 fn test_error_chans_closed() {
8789         // Test that we properly handle error messages, closing appropriate channels.
8790         //
8791         // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
8792         // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
8793         // we can test various edge cases around it to ensure we don't regress.
8794         let chanmon_cfgs = create_chanmon_cfgs(3);
8795         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8796         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8797         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8798
8799         // Create some initial channels
8800         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8801         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8802         let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8803
8804         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8805         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
8806         assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
8807
8808         // Closing a channel from a different peer has no effect
8809         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
8810         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8811
8812         // Closing one channel doesn't impact others
8813         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
8814         check_added_monitors!(nodes[0], 1);
8815         check_closed_broadcast!(nodes[0], false);
8816         assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
8817         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);
8818         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);
8819
8820         // A null channel ID should close all channels
8821         let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8822         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
8823         check_added_monitors!(nodes[0], 2);
8824         let events = nodes[0].node.get_and_clear_pending_msg_events();
8825         assert_eq!(events.len(), 2);
8826         match events[0] {
8827                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8828                         assert_eq!(msg.contents.flags & 2, 2);
8829                 },
8830                 _ => panic!("Unexpected event"),
8831         }
8832         match events[1] {
8833                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8834                         assert_eq!(msg.contents.flags & 2, 2);
8835                 },
8836                 _ => panic!("Unexpected event"),
8837         }
8838         // Note that at this point users of a standard PeerHandler will end up calling
8839         // peer_disconnected with no_connection_possible set to false, duplicating the
8840         // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
8841         // users with their own peer handling logic. We duplicate the call here, however.
8842         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8843         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8844
8845         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
8846         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8847         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8848 }